Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/underware-gg/underdark
Underdark | Made with Dojo
https://github.com/underware-gg/underdark
game on-chain
Last synced: 2 months ago
JSON representation
Underdark | Made with Dojo
- Host: GitHub
- URL: https://github.com/underware-gg/underdark
- Owner: underware-gg
- License: cc0-1.0
- Created: 2023-10-20T14:14:42.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-04-19T00:30:05.000Z (6 months ago)
- Last Synced: 2024-07-28T21:51:04.512Z (2 months ago)
- Topics: game, on-chain
- Language: Cairo
- Homepage: https://underdark.lootunder.world
- Size: 40.7 MB
- Stars: 4
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Underdark
Losing our mind in the Underdark, a generative, on-chain 3D skin-crawler for the Dojo Game Jam #2.
```
__ __ __ __ _____ ______ ______
/\ \/\ \ /\ "-.\ \ /\ __-. /\ ___\ /\ == \
\ \ \_\ \ \ \ \-. \ \ \ \/\ \ \ \ __\ \ \ __<
\ \_____\ \ \_\\"\_\ \ \____- \ \_____\ \ \_\ \_\
\/_____/ \/_/ \/_/ \/____/ \/_____/ \/_/ /_/
_____ ______ ______ __ __
/\ __-. /\ __ \ /\ == \ /\ \/ / scoheth
\ \ \/\ \ \ \ __ \ \ \ __< \ \ _"-. shobro
\ \____- \ \_\ \_\ \ \_\ \_\ \ \_\ \_\ blubble
\/____/ \/_/\/_/ \/_/ /_/ \/_/\/_/ quackir
,----------------------------------------------------.
(_\ \
\ Something ill under Kurnkornor stirs, \
\ down those crumbling old manor stairs, \
\ dark tar that claws and sucks the light, \
\ a ghastly duck no-one can fight, \
\ yet all in life and death be fair, \
\ there's gold and treasure buried there. \
_| |
(_/_________________________(*)_________________________/
| |
) ) _
^%' >(~)____/
(``~~~/
".....had a nightmare about the Slenderduck last night"
-- gabe | cartridge
```
Dripping from the walls, and tangled in your hair,
The dark tar saps your light and strength, 'tis everywhere.
Beware the fading light, and your fraying sanity.
Treading those dark, tangled halls, oh vanity!
Find the treasure, find the key, find stairs to deeper hubris.
Most of all, beware the terrible gibbering of Slenderin Duckeris.
## Team
* Mataleone - Game & Engineering
* GitHub: [@rsodre](https://github.com/rsodre)
* Twitter: [@matalecode](https://twitter.com/matalecode)
* Recipromancer - Renaissance Chaos Mode (& Sound)
* GitHub: [@Rob-Morris](https://github.com/Rob-Morris)
* Twitter: [@recipromancer](https://twitter.com/recipromancer)
* Mononoke - Art & Website
* Twitter: [@MononokeArts](https://twitter.com/MononokeArts)
* Jubilee - Game Art & 3D
* Only the dark night follows Jubilee, so that it may collect the glittering baubles he leaves behind
## Resources
* Starter from open-source [Loot Underworld](https://github.com/funDAOmental/lootunderworld) current rev ([f3b317f](https://github.com/funDAOmental/lootunderworld/tree/f3b317ff03a7b62620f055e5238b9d300f7be189)) CC0
* threejs depth texture [example](https://threejs.org/examples/#webgl_depth_texture) by [@mattdesl](https://twitter.com/mattdesl) CC0
* Color reduction and dither [shader](https://godotshaders.com/shader/color-reduction-and-dither/) by **whiteshampoo**
* Ordered Dithering (Bayer) [shader](https://www.shadertoy.com/view/7sfXDn) by **Tech_*
* [three.js](https://threejs.org/) for graphics
* [tween.js](https://github.com/tweenjs/tween.js) for animation
* Original art made lovingly by hand by `Mononoke`, semi-original art made lovingly with AI assistance by `recipromancer`
* 3D Assets made by `Jubilee`
* Music by `recipromancer`:
* Title Track: Biodecay -- Mazzive Injection (Bonus Track) [1999]
* Ambient: Biodecay -- Down (Depression) [1999]
* Sound effects built by `recipromancer` using sounds from [freesound.org](https://freesound.org/)
* CC0 sounds by `MATRIXXX_`, `DigPro120`, `Merrick079`, `the_semen_incident`, `Nox_Sound`
* [CC Attribution 3.0](https://creativecommons.org/licenses/by/3.0/) sounds
* in fight.mp3 `shocked duck.wav` by `crazyduckman` [on freesound.org](https://freesound.org/people/crazyduckman/sounds/185550/)
* in stairs.mp3 `footsteps_down_stairs_3.WAV` by `sinatra314` [on freesound.org](https://freesound.org/people/sinatra314/sounds/209474/)
* [CC Attribution 4.0](https://creativecommons.org/licenses/by/4.0/)
* in footsteps.mp3 `Footsteps, Muddy, E.wav` by `InspectorJ` [on freesound.org](https://freesound.org/people/InspectorJ/sounds/339325/)
## Game Loop
```mermaid
flowchart TD
MANOR["🏰 Enter the Manor 🏰"] --> |connect wallet + deposit fee| ROOM_SELECT
ROOM_SELECT["Select Room"] --> ROOM_VIEW
ROOM_VIEW["View Room data + levels"] --> START_LEVEL
START_LEVEL["Start Level #1"] --> LEVEL_EXISTS
START_LEVEL --> LEVEL_NEW
LEVEL_EXISTS["Level exists, minted"] --> PLAY_GAME
LEVEL_NEW(("Generate Level
⛓️")) --> |mint level + pay gas| PLAY_GAME
PLAY_GAME["🔥 Play Game 🔥"] --> DIED
PLAY_GAME --> FOUND_EXIT
DIED["🦆 DIED 🦆"] --> PLAY_GAME
FOUND_EXIT["🚪 Found the Exit 🚪"] --> |gameplay proof| VERIFY_PROOF
VERIFY_PROOF(("Verify Gameplay
⛓️")) --> VERIFIED
VERIFY_PROOF --> |bug or cheater| VERIFIED_NOT
VERIFIED_NOT["🚫 Not Verified 🚫"] --> PLAY_GAME
VERIFIED["👍 Verified 👍"] --> |update scores + pay gas| NEXT_NEW
VERIFIED --> NEXT_EXISTS
NEXT_EXISTS["Next Level exists"] --> PLAY_GAME
NEXT_NEW(("Generate Next
⛓️")) --> |mint level + pay gas| PLAY_GAME
```
## Environment Setup [🔗](https://book.dojoengine.org/getting-started/setup.html)
Install Rust + Cargo + others
```
# Install Rust
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
# open new terminal to update PATH
rustup override set stable
rustup update
# Install Cargo
curl --proto '=https' --tlsv1.2 -sSf https://docs.swmansion.com/scarb/install.sh | sh
# other stuff you might need
cargo install toml-cli
brew install protobuf
```
Install the [Cairo 1.0](https://marketplace.visualstudio.com/items?itemName=starkware.cairo1) extension for Visual Studio Code
### Install Dojo [🔗](https://book.dojoengine.org/getting-started/quick-start.html)
Using Dojo 0.5.1
```console
curl -L https://install.dojoengine.org | bash
# open new terminal to update PATH
dojoup -v 0.5.1
# test dojo
cd dojo
sozo build
sozo test
# install packages
cd ../client
npm install
```
## Launch Dojo
#### Terminal 1: Katana (local node)
```console
cd dojo
katana --disable-fee --invoke-max-steps 10000000
# or just...
cd dojo
./run_katana
```
#### Terminal 2: Torii (indexer)
Uncomment the `world_address` parameter in `dojo/Scarb.toml` then:
```console
cd dojo
torii --world 0x6400412d8083e10058277920b8a4a81338727912bc3435e5413f168221e73c7
# or just...
cd dojo
./run_torii
```
#### Terminal 3: Client
```console
cd client
npm install && npm run dev
# or just...
cd dojo
./run_client
```
#### Terminal 4: Sozo commands
```console
# build world and systems
cd dojo
sozo build
# migrate to local Katana
cd dojo
./migrate
```
#### Browser
Open [http://localhost:3000/](http://localhost:3000/)
## Splash Screen
The splash screen code needed to be deployed as separately due to time constraints. The code can be found in this [GitHub Repository](https://github.com/fundaomental/underdark-splash)