Skip to content

Commit

Permalink
Merge pull request #24 from dscpsyl/Version2-dev
Browse files Browse the repository at this point in the history
Upgrade to Version 2
  • Loading branch information
dscpsyl authored Feb 19, 2024
2 parents 4947cc1 + 1584828 commit 7cf83a7
Show file tree
Hide file tree
Showing 18 changed files with 705 additions and 118 deletions.
13 changes: 3 additions & 10 deletions .github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,15 +71,15 @@ You must have a Discord app key and token ready for your bot before you begin. Y
You also must have a presistant instance of MongoDB installed and running somewhere that can be connected to. The script assumes it is on the local machine with the default port configuations.

#### Python Dependencies
1. python3.7>=
1. python3.11>=
2. discordpy
3. pymongo
4. json

### Installation

1. Start by cloning this repository
2. Fill out the `settingsex.json` file with the required information and change it to `settings.json`
2. Fill out the `settings_ex.json` file with the required information and change it to `settings.json`
3. Start up the MongoDB instance
4. We recomend creating a python venv to contain the dependencies of this project.
5. Enter the `Quotebot` folder and run `python3 main.py`
Expand All @@ -92,14 +92,7 @@ You also must have a presistant instance of MongoDB installed and running somewh
<!-- USAGE EXAMPLES -->
## Usage

The format for a command is `{Prefix} "{QUOTE}" {Tag}`. The default prefix of the bot is `"q`.
<br />

Ex.

```
"q "This is my quote" @userinmyserver
```
The quote bot will automatically be looking for messages in the channel that you specify. The format should be "[quote text] [mention]" with only a single mention. The quote bot will automatically handle the quoting and database insertion.


<p align="right">(<a href="#readme-top">back to top</a>)</p>
Expand Down
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.DS_store
settings.json
__pycache__
__pycache__
lib/
pyvenv.cfg
logs/
65 changes: 47 additions & 18 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,76 +1,105 @@
# Changelog

#### Linked versions are to releases.
>`Added` for new features.
>`Changed` for changes in existing functionality.
>`Deprecated` for soon-to-be removed features.
>`Removed` for now removed features.
>`Fixed` for any bug fixes.
>`Security` in case of vulnerabilities.

> `Added` for new features.
> `Changed` for changes in existing functionality.
> `Deprecated` for soon-to-be removed features.
> `Removed` for now removed features.
> `Fixed` for any bug fixes.
> `Security` in case of vulnerabilities.
## v2.0.0

### Added

- Ability to change the bot's listening channel
- Logging for all commands to files and stdout

### Changed

- Bot now listens to a specific channel for quotes instead of commands

###

## v1.3.1

### Added
### Added

- Console Logging

## v1.3.0

### Added

- Ability to change prefix

## v1.2.1

### Changed

- Backend structures

## v1.2.0

### Added
- Ability to edit past quotes

- Ability to edit past quotes

## v1.1.0

### Added

- Ability to edit authors from past quotes

### Changed

- Backend structures

### Fixed

- jumpURL corrections

## v1.0.1

### Changed
- Cleaned up settings variables

- Cleaned up settings variables
- Cleaned up comments

## v1.0.0

### Added
- Completed Basic bot function
### Added

- Completed Basic bot function
- Settings page for some variables

### Changed
- Main database to be Mongodb

- Main database to be Mongodb

## v0.7.3

### Added
### Added

- User Friendly Error Messages
- Spaces between quotes to organize book

### Fixed
- Quoting bugs that would not read author

- Quoting bugs that would not read author

## v0.5.1

### Added
- Basic quoting Function
- Discord Authentication

- Basic quoting Function
- Discord Authentication
- Name and Profile Picture

## v0.1.0

### Added
### Added

- Basic bot function and connection
- Outlined features
- Outlined features
Empty file added Quotebot/logs/.gitinclude
Empty file.
Loading

0 comments on commit 7cf83a7

Please sign in to comment.