feat-documentation

.github/templates/PULL_REQUEST_TEMPLATE.md

@@ -1,12 +1,12 @@
-## Pull Request Overview
-### 📝 Summary 
-- Closes #(issue)
-- 
-### 🔄 Changes Made
-- 
-### 🔧 Tests Results
-- 
-
-### 🔜 Next Steps
-- 
-
+## Pull Request Overview
+### 📝 Summary 
+- Closes #(issue)
+- 
+### 🔄 Changes Made
+- 
+### 🔧 Tests Results
+- 
+
+### 🔜 Next Steps
+- 
+

.github/workflows/test.yaml

@@ -1,21 +1,21 @@
-name: CI
-
-on:
-  push:
-  pull_request:
-
-jobs:
-  sozo-test:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - run: curl -L https://install.dojoengine.org | bash
-      - run: /home/runner/.config/.dojo/bin/dojoup -v v1.0.0-alpha.5
-      - run: |
-          /home/runner/.config/.dojo/bin/sozo build
-          /home/runner/.config/.dojo/bin/sozo test
-          if [[ `git status --porcelain` ]]; then
-            echo The git repo is dirty
-            echo "Make sure to run \"sozo build\" after changing Scarb.toml"
-            exit 1
-          fi
+name: CI
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  sozo-test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - run: curl -L https://install.dojoengine.org | bash
+      - run: /home/runner/.config/.dojo/bin/dojoup -v v1.0.0-alpha.5
+      - run: |
+          /home/runner/.config/.dojo/bin/sozo build
+          /home/runner/.config/.dojo/bin/sozo test
+          if [[ `git status --porcelain` ]]; then
+            echo The git repo is dirty
+            echo "Make sure to run \"sozo build\" after changing Scarb.toml"
+            exit 1
+          fi

.vscode/settings.json

@@ -1,5 +1,5 @@
-{
-    "cairo1.enableLanguageServer": true,
-    "cairo1.enableScarb": true,
-    "cairo1.languageServerPath": "${userHome}/.dojo/bin/dojo-language-server"
-}
+{
+    "cairo1.enableLanguageServer": true,
+    "cairo1.enableScarb": true,
+    "cairo1.languageServerPath": "${userHome}/.dojo/bin/dojo-language-server"
+}

LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2023 Dojo
-
-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) 2023 Dojo
+
+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.

README.md

@@ -1,3 +1,134 @@
+<<<<<<< HEAD
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset=".github/mark-dark.svg">
+  <img    loading="lazy"     style="max-width: 120px; float: right; margin: 0 0 20px 20px;"
+  alt="ByteBeats official logo" align="right" width="120" src="./assets/bytebeastslogo.svg">
+</picture>
+
+<a href="https://x.com/0xByteBeasts">
+<img src="https://img.shields.io/twitter/follow/0xByteBeasts?style=social"/>
+</a>
+<a href="https://x.com/0xByteBeasts">
+<img src="https://img.shields.io/github/stars/ByteBuildersLabs?style=social"/>
+</a>
+
+
+[![Telegram Chat][tg-badge]][tg-url]
+
+[tg-badge]: https://img.shields.io/endpoint?color=neon&logo=telegram&label=chat&style=flat-square&url=https%3A%2F%2Ftg.sumanjay.workers.dev%2Fdojoengine
+[tg-url]: https://t.me/+-84e2pqLtqNkZDAx
+
+## Maintainers 🥷
+
+<table>
+  <tr>
+    <td align="center">
+      <img src="assets/danielcdz.everai.png" width="100px;" alt="Maintainer: danielcdz"/>
+      <br />
+      <a href="https://t.me/danielcdz">danielcdz</a>
+      <br />
+    </td>
+    <td align="center">
+      <img src="assets/marco.everai.jpg" width="100px;" alt="Maintainer: Marco"/>
+      <br />
+      <a href="https://t.me/coxmar23">Marco</a>
+      <br />
+    </td>
+  </tr>
+</table>
+
+# Byte Beasts: Official Guide 🐉🎮
+
+The official Byte Beasts guide, the quickest and most streamlined way to get your Dojo provable game up and running. This guide will assist you with the initial setup, from cloning the repository to deploying your world.
+
+Read the full tutorial [here](https://book.dojoengine.org/tutorial/dojo-starter).
+
+## Prerequisites 📋
+
+To be able to run the ByteBeasts backend you need to have Git, Rust and Scarb installed on your PC to satisfy Dojo dependencies. You can install them with the following steps:
+
+### Install Rust 🦀
+
+Go to the [Rust installation page](https://doc.rust-lang.org/book/ch01-01-installation.html#installing-rustup-on-linux-or-macos)
+
+After installing Rust, ensure your `PATH` environment variable includes the Cargo bin directory (usually `$HOME/.cargo/bin`).
+
+### Install Git 🧑‍💻
+Go to the [Git installation page](https://git-scm.com/downloads) and follow the instructions for your operating system to install Git.
+
+### Install Scarb ⚙️
+The Dojo toolchain integrates [Scarb](https://docs.swmansion.com/scarb/) to build and run Dojo projects, installation instructions are [here](https://docs.swmansion.com/scarb/download.html).
+
+### Install Dojo using `dojoup` 🥋
+
+You can install with the `dojoup` version manager which enables you to easily install, update and manage your Dojo installation.
+
+### Install dojoup 🛠️
+```bash
+curl -L https://install.dojoengine.org | bash
+```
+### Install the Dojo v1.0.0-alpha.5 release 🚀
+
+### Install Dojo using `asdf` 📦
+
+You can alternatively use the `asdf` package manager to install and manage your Dojo installation.
+
+### Install asdf
+
+Follow the [asdf installation instructions](https://asdf-vm.com/guide/getting-started.html)
+
+### Add the asdf-dojo plugin 🔌
+
+```bash
+asdf plugin add dojo https://github.com/dojoengine/asdf-dojo
+```
+
+### Install the latest or a specific version 🆕
+
+```bash
+asdf install dojo latest      # For the latest version
+asdf install dojo 0.7.0       # For a specific version
+
+```
+
+### Set the global or local version  📁
+
+```bash
+asdf global dojo latest       # Set globally
+asdf local dojo 0.7.0         # Set locally in your project directory
+
+```
+
+## Running Locally 🖥️
+
+### Terminal one (Make sure this is running) 🏃
+```bash
+# Run Katana
+katana --disable-fee --allowed-origins "*"
+```
+
+### Terminal two 🔄
+```bash
+# Build the example
+sozo build
+
+# Migrate the example
+sozo migrate apply
+
+# Start Torii
+torii --world 0x70835f8344647b1e573fe7aeccbf044230089eb19624d3c7dea4080f5dcb025 --allowed-origins "*"
+```
+
+## Contribution 🤝
+
+We welcome contributions from developers of all levels! If you're interested in contributing to this project, please follow our  [CONTRIBUTION GUIDELINES](./CONTRIBUTION.md) to get started.
+
+Whether it's fixing bugs, improving documentation, or adding new features, your help is greatly appreciated. Don't hesitate to ask questions or reach out for support—we're here to help!
+
+
+## Communication channel 📢
+If you're a contributor or would like to connect with the project maintainers, feel free to join our [Telegram](https://t.me/+-84e2pqLtqNkZDAx) group!
+=======
 <picture>
   <source media="(prefers-color-scheme: dark)" srcset=".github/mark-dark.svg">
   <img    loading="lazy"     style="max-width: 120px; float: right; margin: 0 0 20px 20px;"
@@ -148,3 +279,4 @@ Whether it's fixing bugs, improving documentation, or adding new features, your
 ## Communication channel 📢
 
 If you're a contributor or would like to connect with the project maintainers, feel free to join our [Telegram](https://t.me/+-84e2pqLtqNkZDAx) group!
+>>>>>>> main

Scarb.toml

@@ -1,17 +1,17 @@
-[package]
-cairo-version = "=2.7.0"
-name = "bytebeasts"
-version = "0.1.0"
-
-[cairo]
-sierra-replace-ids = true
-
-[scripts]
-migrate = "sozo build && sozo migrate apply"
-spawn = "./scripts/spawn.sh"
-move = "./scripts/move.sh"
-
-[dependencies]
-dojo = { git = "https://github.com/dojoengine/dojo", tag = "v1.0.0-alpha.5" }
-
-[[target.dojo]]
+[package]
+cairo-version = "=2.7.0"
+name = "bytebeasts"
+version = "0.1.0"
+
+[cairo]
+sierra-replace-ids = true
+
+[scripts]
+migrate = "sozo build && sozo migrate apply"
+spawn = "./scripts/spawn.sh"
+move = "./scripts/move.sh"
+
+[dependencies]
+dojo = { git = "https://github.com/dojoengine/dojo", tag = "v1.0.0-alpha.5" }
+
+[[target.dojo]]