https://github.com/coldi/r3f-game-demo

A demo on how to do a simple tile-based game with React and react-three-fiber
https://github.com/coldi/r3f-game-demo

Last synced: about 2 months ago
JSON representation

A demo on how to do a simple tile-based game with React and react-three-fiber

• Host: GitHub
• URL: https://github.com/coldi/r3f-game-demo
• Owner: coldi
• License: mit
• Created: 2020-09-27T09:48:47.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2020-10-22T08:08:02.000Z (almost 4 years ago)
• Last Synced: 2024-06-24T09:32:42.292Z (3 months ago)
• Language: TypeScript
• Size: 2.34 MB
• Stars: 625
• Watchers: 6
• Forks: 91
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-react-three-fiber - r3f-game-demo

README

        
# react-three-fiber Game Demo

![Game Demo](/media/game-demo.gif)

This repo shows an example implementation of a top-down 2d game made with React and [react-three-fiber](https://github.com/pmndrs/react-three-fiber).

I used the core functionality to create [Colmen's Quest](https://coldigames.itch.io/colmens-quest) and wanted to give you an idea of how a game can be done with React.

This is by no means the best way to build a game, it's just my way. 😊

**I suggest you use this code as an inspiration and not as a starting point to build your game on top of it. I also do not intend to maintain this code base in any way.**

## Get started

You can start the game by `yarn && yarn start`, then [open your Browser](http://localhost:3000/).

To get a better understanding of the architecture I used, you may want to read [this thread on Twitter](https://twitter.com/coldi/status/1254446313955119104).

👉 Also Florent Lagrede ([@flagrede](https://twitter.com/flagrede)) did an **amazing job** in writing an [in-depth walkthrough about this demo](https://dev.to/flagrede/making-a-2d-rpg-game-with-react-tree-fiber-4af1).


Make sure to check it out! 👀

I'm happy to answer your specific questions about this demo. Just [@coldi](https://twitter.com/coldi) me. 👋

## Known issues

For this demo I used the current version of Colmen's Quest and stripped everything from it except my core "game engine" files. Some code, especially the player movement, might be buggy because there is no turn-based logic anymore.

I don't use a physics engine and the whole collision and movement logic solely relies on tile positions. Therefore you can only move full tiles in this demo.

There are great libraries like [use-cannon](https://github.com/pmndrs/use-cannon) that enable physics-based collisions with react-three-fiber. Check it out! I would love to hear what you made with it!