Browse Source

First Commit

module_rework
Sapein 8 months ago
commit
74c4532f6a
3 changed files with 55 additions and 0 deletions
  1. 1
    0
      AUTHORS
  2. 19
    0
      LICENSE
  3. 35
    0
      README.md

+ 1
- 0
AUTHORS View File

@@ -0,0 +1 @@
1
+Sapeint/Chanku - Initial Work

+ 19
- 0
LICENSE View File

@@ -0,0 +1,19 @@
1
+Copyright (c) 2019 Sapeint/Chanku 
2
+
3
+Permission is hereby granted, free of charge, to any person obtaining a copy
4
+of this software and associated documentation files (the "Software"), to deal
5
+in the Software without restriction, including without limitation the rights
6
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7
+copies of the Software, and to permit persons to whom the Software is
8
+furnished to do so, subject to the following conditions:
9
+
10
+The above copyright notice and this permission notice shall be included in all
11
+copies or substantial portions of the Software.
12
+
13
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19
+SOFTWARE.

+ 35
- 0
README.md View File

@@ -0,0 +1,35 @@
1
+# Almaren Bot  
2
+   This bot is the bot currently used for Almaren.
3
+
4
+### Features  
5
+* 'NSVerify' implementation called OpenNSV™ 
6
+
7
+### Requirements  
8
+* Python 3.4.2
9
+* [discord.py 0.16.2](https://github.com/Rapptz/discord.py/tree/rewrite)
10
+
11
+### Development  
12
+[TO BE WRITTEN]
13
+
14
+### Copyright and License
15
+All copyrights of the bot belongs to the individual authors.
16
+NSVerify belongs to August.
17
+OpenNSV™ belongs to Sapeint/Chanku
18
+
19
+Source code is provided under the MIT License, see LICENSE for more information
20
+
21
+## QnA  
22
+### What is NSVerify?  
23
+   Basically, it's a verification system for NationStates that uses the NationStates Verification API used in Augustin Android. NSVerify is basically an implementation of a system for August's discord bot that uses a basic DB and uses the NationStates Verification API. There is nothing special about NSVerify.  
24
+
25
+### Why not just use NSVerify?  
26
+   Because NSVerify is just a fancy name used by AugstinAndroid to market the idea, it's nothing novel. The only 'novel' thing about it, is some of the features which are easily implemented and replicated. Further, NSVerify's only implementation is in AugstinAndroid, which is closed source and only accessable by August AFAIK, therefore it's impossible to truely audit and host on your own. This leads to some concerns, such as the bot doing 'more things', that it doesn't advertise, without the knowlege of anyone else. This means you can have some peace of mind if you run your own instance.
27
+
28
+### Why not just say you have NSVerify?  
29
+   While I doubt that August would really try to do anything if we claimed that we had NSVerify, he still 'technically' owns the trademark for the name (and I do believe it is unique enough to be tied to the August 'brand' of bot(s)). Additionally there is no open-source for the bot, or for the NSVerify implementation so we have little knowledge of the actual implementation details, instead we implemented everything we could get for information that was available publicly. 
30
+
31
+### What is OpenNSV™?  
32
+   OpenNSV is a system that incorporates the public-facing measures of NSVerify, currently this is the only bot that uses this system. OpenNSV™ will eventually get released as a Python 3 module and also as a Standard (explaining how it works, and how to implement it.). Usage of OpenNSV™  is somewhat regulated at this time.
33
+
34
+### What are the goals of this bot?  
35
+   Be a general bot for Almaren that is both auditable, free, and open for anyone else to use as a base. It's not entirely tracking AugustinAndroid, although it may implement some features that it has.

Loading…
Cancel
Save