vagabond/chronicle_bot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
chronicle_bot/README.md

84 lines
3.2 KiB
Markdown
Raw Permalink Normal View History

Add README and Gemfile
2021-02-07 03:20:13 +00:00
# Chronicle
Chronicle is a multi-purpose chat bot.
It currently supports Matrix, but has ambitions of supporting Discord in the
future.
Chronicle is still heavily work-in-progress, and the hobby of an occasionally
productive fellow.
## Features
Add `help` and `listcommand` logic Both `!help` and `!listcommand` are handled by the bot itself, so take advantage of how the addons method calls work to implement both `matrix_command` and `help_command` on `self`. Add `help_command` to each currently enabled and functional addon
2021-02-15 03:37:56 +00:00
- List available commands (`!listcommands`) and get help with them (`!help
[COMMAND]`)
- Ping (returns `Pong!`; good for testing connectivity)
- Dice Roller (`!roll 2d4` --> `Roll: 2d4 ([2, 1]) ==> 3`)
Add 8ball command
2021-02-08 01:45:54 +00:00
- 8-ball (`!8ball Will I win the lottery?` --> `Try again later`)
README: Update available functionality
2021-02-15 02:17:50 +00:00
- Ad-hoc simple custom commands (`!addcommand hello Hey there!` --> `!hello` -->
`Hey there!`)
Add Docker capabilities README.md: Update with Docker instructions Dockerfile: Add file
2021-02-17 04:15:50 +00:00
- Run in a Docker container!
Add README and Gemfile
2021-02-07 03:20:13 +00:00
- More to come!
## Planned Features
- [ ] Simple calculator (`!calc 8 + (9-10)` --> `Calc: 8 + (9 - 10) ==> 7`)
- [ ] Simple games (Blackjack, High/Low)
- [ ] A "mystery" game (Kind of like _Clue!_ or _Noir Syndrome_)
- [ ] A "progress quest" like game (time-based character auto-progression)
- [ ] Expanded custom commands (allow for commands with arguments)
- [ ] Enabling of add-on features (ie., everything mentioned above) per room
- [ ] Establish/restrict command permissions per user/role per room.
- [ ] Change the command prefix (from default `!` to whatever you'd like!)
# Development
You can run your own instance of Chronicle with a few steps:
1. Fork the repository, and clone it locally
Add Docker capabilities README.md: Update with Docker instructions Dockerfile: Add file
2021-02-17 04:15:50 +00:00
2. Setup a bot user in Matrix, and get its "Access Token"
Refactor for ActiveRecord and Config Files Update Custom Commands to leverage ActiveRecord and save commands to a database. By default, it will use SQLite. Configuration for this (and potential configuration for PostgreSQL and MySQL) live in `config/db.yml`. Inculde a Rakefile for handling DB creation and migrations. Rakefile: Add Rakefile to handle running the bot, and DB management Gemfile: Update with new gem dependencies db/migrate/*: ActiveRecord migrations for Custom Command custom_commands.rb: Update to leverage ActiveRecord Leverage the Rakefile to start the bot, removing the binary file. Update the Dockerfile to also leverage the Rakefile. Dockerfile: Update to use Rakefile, and install new dependencies chronicle: Remove unnecessary start file Refactor the `chronicle_bot` file into `chronicle` and `matrix` chronicle.rb: General Chronicle setup matrix.rb: Start a Matrix-specific bot Update the bot to read configuration from files, instead of either the environment, or hard-coded values. config/db.yml: Database configuration config/bot.yml: General bot configuration Update the README to reflect the above change with regards to running the bot either using the Rakefile, or using a Docker container.
2021-02-28 00:40:54 +00:00
3. Update `config/bot.yml` with the Homeserver URL, and the Access Token
4. Update `config/db.yml` with any desired changes (defaults use SQLite)
5. (Optional) Update `config/bot.yml` with any additional changes
Add Docker capabilities README.md: Update with Docker instructions Dockerfile: Add file
2021-02-17 04:15:50 +00:00
6. Run `bundle update` to install dependencies
Refactor for ActiveRecord and Config Files Update Custom Commands to leverage ActiveRecord and save commands to a database. By default, it will use SQLite. Configuration for this (and potential configuration for PostgreSQL and MySQL) live in `config/db.yml`. Inculde a Rakefile for handling DB creation and migrations. Rakefile: Add Rakefile to handle running the bot, and DB management Gemfile: Update with new gem dependencies db/migrate/*: ActiveRecord migrations for Custom Command custom_commands.rb: Update to leverage ActiveRecord Leverage the Rakefile to start the bot, removing the binary file. Update the Dockerfile to also leverage the Rakefile. Dockerfile: Update to use Rakefile, and install new dependencies chronicle: Remove unnecessary start file Refactor the `chronicle_bot` file into `chronicle` and `matrix` chronicle.rb: General Chronicle setup matrix.rb: Start a Matrix-specific bot Update the bot to read configuration from files, instead of either the environment, or hard-coded values. config/db.yml: Database configuration config/bot.yml: General bot configuration Update the README to reflect the above change with regards to running the bot either using the Rakefile, or using a Docker container.
2021-02-28 00:40:54 +00:00
7. Run `rake chronicle:start`
Add Docker capabilities README.md: Update with Docker instructions Dockerfile: Add file
2021-02-17 04:15:50 +00:00
8. Invite the bot user to a room, and `!ping` to make sure it's working!
# Docker
The included Dockerfile is very simplistic, and may be expanded in the future.
For now, there is no pre-built image stored in a Hub, so you'll need to build
Refactor for ActiveRecord and Config Files Update Custom Commands to leverage ActiveRecord and save commands to a database. By default, it will use SQLite. Configuration for this (and potential configuration for PostgreSQL and MySQL) live in `config/db.yml`. Inculde a Rakefile for handling DB creation and migrations. Rakefile: Add Rakefile to handle running the bot, and DB management Gemfile: Update with new gem dependencies db/migrate/*: ActiveRecord migrations for Custom Command custom_commands.rb: Update to leverage ActiveRecord Leverage the Rakefile to start the bot, removing the binary file. Update the Dockerfile to also leverage the Rakefile. Dockerfile: Update to use Rakefile, and install new dependencies chronicle: Remove unnecessary start file Refactor the `chronicle_bot` file into `chronicle` and `matrix` chronicle.rb: General Chronicle setup matrix.rb: Start a Matrix-specific bot Update the bot to read configuration from files, instead of either the environment, or hard-coded values. config/db.yml: Database configuration config/bot.yml: General bot configuration Update the README to reflect the above change with regards to running the bot either using the Rakefile, or using a Docker container.
2021-02-28 00:40:54 +00:00
your own.
Add Docker capabilities README.md: Update with Docker instructions Dockerfile: Add file
2021-02-17 04:15:50 +00:00
Refactor for ActiveRecord and Config Files Update Custom Commands to leverage ActiveRecord and save commands to a database. By default, it will use SQLite. Configuration for this (and potential configuration for PostgreSQL and MySQL) live in `config/db.yml`. Inculde a Rakefile for handling DB creation and migrations. Rakefile: Add Rakefile to handle running the bot, and DB management Gemfile: Update with new gem dependencies db/migrate/*: ActiveRecord migrations for Custom Command custom_commands.rb: Update to leverage ActiveRecord Leverage the Rakefile to start the bot, removing the binary file. Update the Dockerfile to also leverage the Rakefile. Dockerfile: Update to use Rakefile, and install new dependencies chronicle: Remove unnecessary start file Refactor the `chronicle_bot` file into `chronicle` and `matrix` chronicle.rb: General Chronicle setup matrix.rb: Start a Matrix-specific bot Update the bot to read configuration from files, instead of either the environment, or hard-coded values. config/db.yml: Database configuration config/bot.yml: General bot configuration Update the README to reflect the above change with regards to running the bot either using the Rakefile, or using a Docker container.
2021-02-28 00:40:54 +00:00
1. Fork the repository, and clone it locally
2. Setup a bot user in Matrix, and get its "Access Token"
3. Update `config/bot.yml` with the Homeserver URL, and the Access Token
4. Update `config/db.yml` with any desired changes (defaults use SQLite)
5. (Optional) Update `config/bot.yml` with any additional changes
6. Build the image: `docker build -t chronicle-bot .`
7. Run Chronicle in Docker with `docker run --rm --name chronicle chronicle-bot`
8. Invite the bot user to a room, and `!ping` to make sure it's working!
Add README and Gemfile
2021-02-07 03:20:13 +00:00
# Contribute
If you are interested in contributing to Chronicle, first let me say thanks!
Next, please follow these steps:
1. Fork the repository, and perform any changes you'd like.
2. Submit a pull request, explaining the changes.
3. Work with me to get those changes merged.
Chronicle is a hobby project, and as such I may not be immediately responsive to
any requests. Please do not be discouraged! I will try to address any issues or
pull requests in a reasonable time.
# Issues
If you find something amiss with Chronicle, please submit an issue! I will try
to address it in a reasonable time.
# Contact
If you're interested in discussing Chronicle, you can speak with me on Matrix!
I'm [Vagabond](https://matrix.to/#/@vagabondazulien:exp.farm).
Reference in a new issue Copy permalink