Skip to content

Commit

Permalink
chore: update
Browse files Browse the repository at this point in the history
  • Loading branch information
0xibs committed Jan 31, 2025
1 parent cc9c0b3 commit 8d03359
Show file tree
Hide file tree
Showing 204 changed files with 14 additions and 32,121 deletions.
23 changes: 0 additions & 23 deletions .github/workflows/client_ci.yml

This file was deleted.

36 changes: 0 additions & 36 deletions .github/workflows/commitlint.yml

This file was deleted.

2 changes: 1 addition & 1 deletion .github/workflows/test_contracts.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ jobs:
steps:
- uses: actions/checkout@v3
- run: curl -L https://install.dojoengine.org | bash
- run: /home/runner/.config/.dojo/bin/dojoup -v v1.0.9
- run: /home/runner/.config/.dojo/bin/dojoup -v v1.1.2
- run: |
cd onchain
/home/runner/.config/.dojo/bin/sozo build
Expand Down
2 changes: 0 additions & 2 deletions Design.md

This file was deleted.

74 changes: 1 addition & 73 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,6 @@ _<div style="text-align: center">Ludo game, on Starknet</div>_
<table >
<tr>
</tr>
<tr>
<td>Website</td>
<td><a href="https://starkludo.com">https://starkludo.com</a></td>
</tr>
<tr>
<td>Documentation</td>
<td><a href="https://book.starkludo.com">https://book.starkludo.com</a></td>
</tr>
</table></div>

Expand All @@ -28,40 +21,6 @@ At the start of the game, all players are assigned 4 pieces each. The goal is to

The game can be played by either 2, 3 or four people. In each game, there can only be one loser. For example, if the game is played by 4 people, the first 3 players to reach the finish spot are the winners. The player that reaches first gets the first position, the player that reaches second gets the second position, and the third gets the third position.


### How to play

#### Single player mode:

1. Launch the app
2. Connect Wallet
3. Choose resume a game or start a new game
4. Select number of players you want to use
5. Choose user account
6. Start game

#### Multiplayer mode:

1. Launch the app
2. Connect Wallet
3. Choose join a game or start a new game
4. Select number of players you want to use
5. You get an invitation code to invite another player
6. Customize your avatar theme color
7. Choose user account
8. Start game

### Screenshots

![](./assets/readme-asset/launch-game.png)
![](./assets/readme-asset/launchgamefinal2.png)
![](./assets/readme-asset/choose-avatar.png)
![](./assets/readme-asset/choose-board.png)
![](./assets/readme-asset/choose-players.png)
![](./assets/readme-asset/choose-account.png)
![](./assets/readme-asset/global-rank.png)
![](./assets/readme-asset/setting.png)

## Development

Steps to build and run StarkLudo locally
Expand All @@ -71,31 +30,14 @@ Steps to build and run StarkLudo locally
**_Ensure you have the prerequisites installed before proceeding.
Check [here](https://book.dojoengine.org/getting-started#prerequisites) for guide on how to install the prerequisites._**

**NB:** Make sure you have node and npm installed.
Run `node -v && npm -v` on the terminal to check if they are installed else install them.

```
$ node -v && npm -v
v22.12.0
10.9.0
```

### Install tools

1. [Install pnpm](https://pnpm.io/installation#using-npm)

```bash
npm install -g pnpm
```

2. [Install Dojo](https://book.dojoengine.org/getting-started#install-dojo-using-dojoup)

```bash
# Install dojoup
curl -L https://install.dojoengine.org | bash

# Install Dojo release
dojoup --version v1.0.5
dojoup --version v1.1.2
```

### Build and run StarkLudo
Expand Down Expand Up @@ -155,20 +97,6 @@ sozo test -f test_contract_deployment
> **_For more information about testing, check [Dojo book](https://book.dojoengine.org/framework/testing)_**

### Client
> Please note that Katana and Torii servers needs to be up and running before the client server can run successfully
```bash
# Navigate to the client directory
cd client

# Install dependencies
pnpm i

# Run
pnpm dev
```

## License

This project is licensed under the MIT License. See [License](./LICENSE) for more information
Expand Down
3 changes: 3 additions & 0 deletions assets/FIGMA_DESIGNS.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,6 @@ https://www.figma.com/design/j5s4p4Bg37Vll1BSaqRTN0/Design-more-ludo-boards?node

- [Tonyverse-ops] 3D game backgrounds:
- https://drive.google.com/drive/folders/1eILz_MHgzfBS5sPav8pZv0vSNbM6qlcQ?usp=drive_link

Web and Mobile Game UI Design - https://www.figma.com/design/65jfAMjIcnKXTPfAYsTtTJ/Game-UI?node-id=125-18397&t=bygBElVuLzATvhzo-1
Book theme redesign - https://www.figma.com/design/SbVgQdwNdjMzRmER0k2ddB/Strk-Ludo-Game-Book?node-id=0-1&t=gp4Hs3gMN3y4QRox-1
Binary file removed assets/readme-asset/choose-account.png
Binary file not shown.
Binary file removed assets/readme-asset/choose-avatar.png
Binary file not shown.
Binary file removed assets/readme-asset/choose-board.png
Binary file not shown.
Binary file removed assets/readme-asset/choose-color-multi.png
Binary file not shown.
Binary file removed assets/readme-asset/choose-color.png
Binary file not shown.
Binary file removed assets/readme-asset/choose-cpufinal.png
Binary file not shown.
Binary file removed assets/readme-asset/choose-dice.png
Binary file not shown.
Binary file removed assets/readme-asset/choose-joingame.png
Binary file not shown.
Binary file removed assets/readme-asset/choose-players.png
Binary file not shown.
Binary file removed assets/readme-asset/global-rank.png
Binary file not shown.
Binary file removed assets/readme-asset/help.png
Binary file not shown.
Binary file removed assets/readme-asset/launch-game.png
Binary file not shown.
Binary file removed assets/readme-asset/launchgamefinal2.png
Binary file not shown.
Binary file removed assets/readme-asset/launchgamefinal3.png
Binary file not shown.
Binary file removed assets/readme-asset/setting.png
Binary file not shown.
Binary file removed assets/readme-asset/stake.png
Binary file not shown.
28 changes: 0 additions & 28 deletions client/.gitignore

This file was deleted.

47 changes: 0 additions & 47 deletions client/README.md

This file was deleted.

9 changes: 0 additions & 9 deletions client/dojoConfig.ts

This file was deleted.

63 changes: 0 additions & 63 deletions client/eslint.config.cjs

This file was deleted.

53 changes: 0 additions & 53 deletions client/index.html

This file was deleted.

Loading

0 comments on commit 8d03359

Please sign in to comment.