From 221c2ccf770b5b2e3a8d015a3e8eb68796cda466 Mon Sep 17 00:00:00 2001 From: Bill Kudo Date: Sat, 25 Apr 2020 11:10:46 -0700 Subject: [PATCH] Added Readme and License --- LICENSE | 7 +++++++ README.md | 37 +++++++++++++++++++++++++++++++++++++ 2 files changed, 44 insertions(+) create mode 100644 LICENSE create mode 100644 README.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d686bf9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,7 @@ +Copyright 2020 Bill K. + +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. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..401b906 --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +## Basic Usage + +#### Requirements +- Git +- Cargo (Rustup) + +##### Step 1 - Build the project +Simply do `cargo build --release`. It might take a while. + +##### Step 2 - Write the Script that Igneous should follow + +The script format is simple. There are 3 command types: +`S!bot? are you there?` - wait for user to type the preset string ("bot? are you there?") +`I!yeah, I'm here` - reply with the preset string ("yeah, I'm here") +`IMG![images/bot-selfie.png]` - reply with image + +All commands **must** have a timeout (the timeout **can** be `0.0`) after the command executes: +`S!bot? are you there?+3.0` - wait 3 seconds after the user types the preset string + +Always start a bot with an `S!`. That would be your trigger. + +A simple ping-pong bot: +``` +S!bot? are you there?+2.0 +I!yeah, I'm here+0.0 +S!ok+2.0 +I!soooooo, why did you call me?+0.0 +IMG![Confused.png]+0.0 +``` + +Save the file. + +##### Step 3 - Run + +Use the following command to run the bot: + +`DISCORD_TOKEN="" ./target/release/Igneous ` \ No newline at end of file