-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
f457c32
commit 991e091
Showing
3 changed files
with
118 additions
and
117 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,2 @@ | ||
| * text=auto eol=lf | ||
| .devcontainer/** linguist-vendored |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,21 +1,21 @@ | ||
| MIT License | ||
| Copyright (c) 2018 Erisa Arrowsmith (Seriel) | ||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. | ||
| MIT License | ||
|
|
||
| Copyright (c) 2018 Erisa Arrowsmith (Seriel) | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,96 +1,96 @@ | ||
| # Commandrb | ||
|
|
||
| A customisable and (probably) easy to use commands system for discordrb | ||
| It's probably not recommended to use this in it's early stages (< 1.0) because it will be riddled with bugs and features that don't work as intended. | ||
| However, feel free to use it if you want, just don't be surprised when it doesn't work exactly the way you want it to. (If you find an issue feel free to report it, just don't act all entitled, you were warned.) | ||
|
|
||
| # Creating a bot with Commandrb | ||
|
|
||
| ## Requirements | ||
| - Ruby 2.4+ (2.6+ is recommended) | ||
| - [discordrb](https://github.com/discordrb/discordrb) 3.0+ | ||
|
|
||
| ## Install | ||
| You can do this by one of two ways: | ||
| The most simple is to just install the gem and then get developing: | ||
| ```sh | ||
| gem install commandrb | ||
| ``` | ||
|
|
||
| However, espcially in a large project, it is recommended to use bundler (`gem install bundler`) and add this to your `Gemfile`: | ||
| ```sh | ||
| gem 'commandrb' | ||
| ``` | ||
| You can then install commandrb for your project with `bundle install` and manage other dependancies alongside it in your gemfile. | ||
|
|
||
| ## Usage | ||
| A simple bot can be made like so: | ||
| ```ruby | ||
| require 'discordrb' | ||
| require 'commandrb' | ||
|
|
||
| cbot = CommandrbBot.new( | ||
| { | ||
| token: '<insert token here>', | ||
| client_id: 168123456789123456, | ||
| prefixes: ['!'] | ||
| } | ||
| ) | ||
|
|
||
| cbot.add_command(:ping, | ||
| code: proc { |event,args| | ||
| event.respond('Pong!') | ||
| } | ||
| ) | ||
|
|
||
| cbot.bot.run | ||
| ``` | ||
| The above example can be used as a means of testing if commandrb is installed properly. Replace the token and client ID in the example with your own and run it. The bot should respond to every `!ping` with `Pong!` | ||
|
|
||
| If this example works then congratulations, you have successfully installed commandrb! You can now check out the docs for more information, or check the `examples` folder on GitHub to see a couple more complex examples of bots. | ||
|
|
||
| For example of a large bot using this system, you can view my own bot, [Yuuki-Bot](https://github.com/Yuuki-Discord/Yuuki-Bot) and learn from the examples inside it. | ||
|
|
||
| ## Updating | ||
| It is best to update commandrb alongside all your other gems. | ||
|
|
||
| If you installed as an ordinary gem: | ||
| ```sh | ||
| gem update | ||
| ``` | ||
|
|
||
| If you are using bundler: | ||
| ```sh | ||
| bundle update | ||
| ``` | ||
|
|
||
| That should update commandrb and all your other gems to the latest versions. | ||
|
|
||
| If you instead for some reason need to update just commandrb as an ordinary gem, it would be `gem update commandrb` | ||
|
|
||
| ## Versioning | ||
| While the framework is still in the testing phase (Before 1.0.0), I reserve the right to make any breaking changes at any time without warning. Please check the commit history to view the changes until I start creating a changelog. | ||
|
|
||
| After 1.0.0 has been released, all breaking changes (Which require editing your bot) will only be on full realeases (For example 1.0.0 -> 2.0.0). These releases may contain breaking changes which require you to edit your bot. Such releases will also contain full changelogs detailing what is required for you to convert your bot to a different commandrb version. Every attempt will be made to make the changes you'll need make as minimal as possible. | ||
|
|
||
| For minor releases (For example 1.0.0 -> 1.1.0) there will be no breaking changes, but changelogs will be given. | ||
|
|
||
| Changelogs may not be given for all bugfix versions (For example 1.0.0 -> 1.0.1) however such changes will be detailed in the next minor release changelogs. As the name suggests, bugfix changes will be reserved for bug fixes and patches only, and will not contain any new features. These releases will not break any bots, and should be installed as soon as possible to maintain the stability and security of your bot. | ||
|
|
||
| Changes will be pushed to the master branch at GitHub before release, this means that the GitHub version may contain new features and fixes compared to the release versions.<br /> | ||
| To use the git version in your project, add the following to your Gemfile: (If you're not using bundler, now is a good time to start) | ||
| ```ruby | ||
| gem 'commandrb', git: 'https://github.com/Yuuki-Discord/commandrb.git' | ||
| ``` | ||
| Please note that the git version does not include official changelogs outside of the commit history. In addition, changes to the git version may not be fully tested in all cases, so take care when using it for an important project. | ||
|
|
||
| ## Bot Examples | ||
| The following is a list of sponsered projects that are using commandrb, and can be used as examples for commandrb usage: | ||
|
|
||
| - [Yuuki-Bot](https://github.com/Yuuki-Discord/Yuuki-Bot), by [Erisa](https://github.com/Erisa) | ||
|
|
||
| To add to this list, either add the project to the above list in the same format via a Pull Request or [Issue](https://github.com/Yuuki-Discord/commandrb/issues). | ||
|
|
||
| ## Support | ||
| Please report any issues by opening an [Issue](https://github.com/Yuuki-Discord/commandrb/issues) on Github! <br /> | ||
| You can also join our server for support! https://discord.gg/Q2XzDEt <br /> | ||
| # Commandrb | ||
|
|
||
| A customisable and (probably) easy to use commands system for discordrb | ||
| It's probably not recommended to use this in it's early stages (< 1.0) because it will be riddled with bugs and features that don't work as intended. | ||
| However, feel free to use it if you want, just don't be surprised when it doesn't work exactly the way you want it to. (If you find an issue feel free to report it, just don't act all entitled, you were warned.) | ||
|
|
||
| # Creating a bot with Commandrb | ||
|
|
||
| ## Requirements | ||
| - Ruby 2.4+ (2.6+ is recommended) | ||
| - [discordrb](https://github.com/discordrb/discordrb) 3.0+ | ||
|
|
||
| ## Install | ||
| You can do this by one of two ways: | ||
| The most simple is to just install the gem and then get developing: | ||
| ```sh | ||
| gem install commandrb | ||
| ``` | ||
|
|
||
| However, espcially in a large project, it is recommended to use bundler (`gem install bundler`) and add this to your `Gemfile`: | ||
| ```sh | ||
| gem 'commandrb' | ||
| ``` | ||
| You can then install commandrb for your project with `bundle install` and manage other dependancies alongside it in your gemfile. | ||
|
|
||
| ## Usage | ||
| A simple bot can be made like so: | ||
| ```ruby | ||
| require 'discordrb' | ||
| require 'commandrb' | ||
|
|
||
| cbot = CommandrbBot.new( | ||
| { | ||
| token: '<insert token here>', | ||
| client_id: 168123456789123456, | ||
| prefixes: ['!'] | ||
| } | ||
| ) | ||
|
|
||
| cbot.add_command(:ping, | ||
| code: proc { |event,args| | ||
| event.respond('Pong!') | ||
| } | ||
| ) | ||
|
|
||
| cbot.bot.run | ||
| ``` | ||
| The above example can be used as a means of testing if commandrb is installed properly. Replace the token and client ID in the example with your own and run it. The bot should respond to every `!ping` with `Pong!` | ||
|
|
||
| If this example works then congratulations, you have successfully installed commandrb! You can now check out the docs for more information, or check the `examples` folder on GitHub to see a couple more complex examples of bots. | ||
|
|
||
| For example of a large bot using this system, you can view my own bot, [Yuuki-Bot](https://github.com/Yuuki-Discord/Yuuki-Bot) and learn from the examples inside it. | ||
|
|
||
| ## Updating | ||
| It is best to update commandrb alongside all your other gems. | ||
|
|
||
| If you installed as an ordinary gem: | ||
| ```sh | ||
| gem update | ||
| ``` | ||
|
|
||
| If you are using bundler: | ||
| ```sh | ||
| bundle update | ||
| ``` | ||
|
|
||
| That should update commandrb and all your other gems to the latest versions. | ||
|
|
||
| If you instead for some reason need to update just commandrb as an ordinary gem, it would be `gem update commandrb` | ||
|
|
||
| ## Versioning | ||
| While the framework is still in the testing phase (Before 1.0.0), I reserve the right to make any breaking changes at any time without warning. Please check the commit history to view the changes until I start creating a changelog. | ||
|
|
||
| After 1.0.0 has been released, all breaking changes (Which require editing your bot) will only be on full realeases (For example 1.0.0 -> 2.0.0). These releases may contain breaking changes which require you to edit your bot. Such releases will also contain full changelogs detailing what is required for you to convert your bot to a different commandrb version. Every attempt will be made to make the changes you'll need make as minimal as possible. | ||
|
|
||
| For minor releases (For example 1.0.0 -> 1.1.0) there will be no breaking changes, but changelogs will be given. | ||
|
|
||
| Changelogs may not be given for all bugfix versions (For example 1.0.0 -> 1.0.1) however such changes will be detailed in the next minor release changelogs. As the name suggests, bugfix changes will be reserved for bug fixes and patches only, and will not contain any new features. These releases will not break any bots, and should be installed as soon as possible to maintain the stability and security of your bot. | ||
|
|
||
| Changes will be pushed to the master branch at GitHub before release, this means that the GitHub version may contain new features and fixes compared to the release versions.<br /> | ||
| To use the git version in your project, add the following to your Gemfile: (If you're not using bundler, now is a good time to start) | ||
| ```ruby | ||
| gem 'commandrb', git: 'https://github.com/Yuuki-Discord/commandrb.git' | ||
| ``` | ||
| Please note that the git version does not include official changelogs outside of the commit history. In addition, changes to the git version may not be fully tested in all cases, so take care when using it for an important project. | ||
|
|
||
| ## Bot Examples | ||
| The following is a list of sponsered projects that are using commandrb, and can be used as examples for commandrb usage: | ||
|
|
||
| - [Yuuki-Bot](https://github.com/Yuuki-Discord/Yuuki-Bot), by [Erisa](https://github.com/Erisa) | ||
|
|
||
| To add to this list, either add the project to the above list in the same format via a Pull Request or [Issue](https://github.com/Yuuki-Discord/commandrb/issues). | ||
|
|
||
| ## Support | ||
| Please report any issues by opening an [Issue](https://github.com/Yuuki-Discord/commandrb/issues) on Github! <br /> | ||
| You can also join our server for support! https://discord.gg/Q2XzDEt <br /> |