innaircbot/README.md

44 lines
1.5 KiB
Markdown
Raw Normal View History

2018-12-16 17:27:44 +03:00
# InnaIrcBot
Another one IRC bot in deep beta.
2018-12-16 17:32:51 +03:00
## Usage
2018-12-16 17:27:44 +03:00
` -c, --configuration <name.config> [<name1.config> ...] Read Config`
` -g, --generate [name.config] Generate Config`
` -v, --version Get application version`
2018-12-16 17:32:51 +03:00
#### Configuration settings
2018-12-16 17:27:44 +03:00
"userNickAuthStyle": "rusnet" or "freenode"
* rusnet - send '/nickserv IDENTIFY mySecretPass'
* freenode - send '/msg nickserv IDENTIFY mySecretPass'
"logDriver" could be "Files", "SQLite" or "Zero"
* Files - log everything to files using /yourPathSet/serverName/#chanelName_YYYY-MM-DD.txt format.
* SQLite - use /yourPathSet/server.db (or /yourPathSet/yourFileName.db) sqlite file.
2018-12-16 17:32:51 +03:00
## License
2018-12-16 17:27:44 +03:00
Source code spreads under the GNU General Public License v3 or higher. Please see LICENSE file.
Used libraries:
* GSON: https://github.com/google/gson
* sqliteJDBC: https://bitbucket.org/xerial/sqlite-jdbc
## TODO:
- [ ] Documentation
- [ ] Code refactoring
- [ ] QA: good regression testing
2019-01-01 23:20:10 +03:00
- [x] CI/CD Jenkins
2018-12-16 17:27:44 +03:00
- [ ] Suppress messages from server or handle them separately from selected worker
- [ ] Logs backend workers as threads (SQLite and co. are too slow)
- [ ] Logs backend worker for mongodb
- [ ] Logs backend worker for redis/redis node
- [ ] Re-implement connection routine
- [ ] Availability to run scripts @ 'ChanelCommander'
- [ ] Docker(+compose) package
- [ ] Flood tracker
- [ ] Deep configuration files validation
2018-12-19 04:48:03 +03:00
- [x] Maven ~~or Gradle~~ build
2018-12-16 17:27:44 +03:00
- [ ] ncurses-like or/and GUI configuration files (server/chanel setting) editor