Skip to content

Commit

Permalink
Refactor: Preparations for release
Browse files Browse the repository at this point in the history
  • Loading branch information
Conner-Anderson committed Aug 5, 2023
1 parent 443bbb3 commit 7b3a604
Show file tree
Hide file tree
Showing 5 changed files with 720 additions and 771 deletions.
8 changes: 5 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ All noteable changes to this project will be documented in this file.

#### Features

- Added modal chatbots. These are chatbots that appear as pop-up windows within Discord with a list of questions and fill-in dialogues.
- Added modal chatbots. These are chatbots that appear as pop-up windows within Discord with a list of questions and fill-in dialogues.
They are an alternative to direct-message chatbots that register players and log tags.
Their requirements are more restrictive, but they are quicker to use: especially on mobile.
See the updated chatbot documentation for details.
- The default tag_logging chatbot script is now modal.
Expand All @@ -19,7 +20,7 @@ See the updated chatbot documentation for details.
- The location and name of the database file can now be specified in config.yml
- Updated the underlying libraries to stay up-to-date with Discord API changes
- Improved general error handling regarding the chatbot
- Under-the-hood reorganization for easier to navigate code
- Under-the-hood reorganization for easier to navigate code. This is the biggest risk of bugs.

#### Breaking Changes

Expand All @@ -28,7 +29,8 @@ See the updated chatbot documentation for details.
- Since the database file location and name can be specified in `config.yml`, old configs will be missing the `database_path` field.
The bot will still load `hvzdb.db` files from the original location, but this is depreciated.
You may wish to copy the notes and field from the new `config.yml`
- Since the core code has been reorganized, there is a new installation method. See the [documentation](https://conner-anderson.github.io/discord-hvz-docs/0.3.0/installation/#updating).
- Since the core code has been reorganized, there is a new installation method for the Advanced Install. See the [documentation](https://conner-anderson.github.io/discord-hvz-docs/0.3.0/installation/#updating).
Specifically, do not merely copy the new files atop the old.

### 0.2.1 Patch Release

Expand Down
4 changes: 2 additions & 2 deletions config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ registration: true
tag_logging: true

# If true, the OZ's identity will not be included in tag announcements.
silent_oz: false
#silent_oz: false

# Will the database be automatically exported to a Google Sheet? Requires some setup.
# Turn this off if you're having trouble with Google Sheets
Expand Down Expand Up @@ -90,5 +90,5 @@ database_tables:
# For a file in the top directory (default), use "name_of_my_database.db"
# For a file in a directory within the top directory, use "my_database_folder/my_database_name.db"
# To start your path at the root of the drive, start with a '/'. Example: "/Users/JohnDoe/Documents/discord-hvz/cool_database.db"
database_path: "hvzdb.db"
database_path: "game_database.db"

Loading

0 comments on commit 7b3a604

Please sign in to comment.