Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/McRaeAlex/RustySnake
A BattleSnake template written in rust
https://github.com/McRaeAlex/RustySnake
battlesnake rest-api rocket rocket-rs rust webdev
Last synced: about 2 months ago
JSON representation
A BattleSnake template written in rust
- Host: GitHub
- URL: https://github.com/McRaeAlex/RustySnake
- Owner: McRaeAlex
- License: mit
- Created: 2018-03-20T02:24:16.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-02-25T05:14:57.000Z (over 3 years ago)
- Last Synced: 2024-04-08T02:24:48.419Z (5 months ago)
- Topics: battlesnake, rest-api, rocket, rocket-rs, rust, webdev
- Language: Rust
- Homepage:
- Size: 46.9 KB
- Stars: 6
- Watchers: 1
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Rusty Snake
Rusty is a battle snake built with Rocket, a rust web developement framework.
The project was recently updated with version 1.0 of battlesnake.
## Note:
If you just want to use this as the starter snake run this command in the directory.
```
git checkout template
```
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
### Prerequisites
In order to use and develope Rusty your going to need a few things:
1. [Rust](https://www.rust-lang.org/en-US/install.html)
2. [A very basic understanding of the web](https://code.tutsplus.com/tutorials/http-the-protocol-every-web-developer-must-know-part-1--net-31177)
3. [A understanding of the game this bot is trying to play](https://github.com/sendwithus/battlesnake-server/#readme)
### Installing
Once your done with the basics copy and paste the command below into your terminal:
```
git clone https://github.com/McRaeAlex/RustySnake.git
```
Then
```
cd RustySnake
git checkout template
cargo run
```
You should see something like this
```
Configured for development.
=> address: localhost
=> port: 8000
=> log: normal
=> workers: 8
=> secret key: generated
=> limits: forms = 32KiB
=> tls: disabled
🛰 Mounting '/':
=> GET /
=> POST /start
🚀 Rocket has launched from http://localhost:8000
```
if you don't and it gives you errors saying missing features or something about nightly, run:
```
rustup default nightly
```
to switch your default toolchain to nightly
to install nightly
```
rustup install nightly
```
To push it to your own repo
```
git push -u
```
And your done!
## Running the tests:
Using the package manager bundled with rust run:
```
cargo test
```
## Deployment (TODO)
Add additional notes about how to deploy this on a live system
## Built With
* [Rust](https://www.rust-lang.org/en-US/install.html) - The programming language used
* [Rocket](https://rocket.rs/) - The web framework used
* [Serde](https://serde.rs) - Used to serialize and deserialize json
## Contributing
This is more of a personal project than anything. However if you would like to contribute shoot me a email: [email protected]
## Authors
* **Alexander McRae** - *Everything so far* - [Alex McRae](http://www.alexandermcrae.com)
## License
MIT License
Copyright (c) 2019 Alexander McRae
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.