React Game Engine Template
This repo is designed to be a sort of game kickstarter. It contains some general systems and components that should be somewhat useful when developing a variety of games using React Game Engine.
The underlying renderer is ThreeJS.
The template will contain both 3D and 2D game entities (sprites) and potentially some particles.
This project uses Create React App because quite frankly, it is the easiest and most stable way to get up and running with a React web project.
How to start
git clone https://github.com/bberak/react-game-engine-template.git [new-game]
cd [new-game]
rm -rf .git # Windows: rmdir /S .git
git init
git add .
git commit -m "First commit"
git remote add origin https://github.com/[you]/[new-game].git
git push -u origin master
Then, install the dependencies and start the app:
npm install
npm run start
This template contains the following:
- Stick (Gamepad) controllers
- A simple HUD
- Particle systems
- Sound support
- Physics implementation powered by Oimo
- ThreeJS rendering
- Post-processing effects
- Sprite support with animations
All of the above systems and components are hackable and extensible - which should allow for quick[er] prototyping.
Available Scripts
In the project directory, you can run:
npm start
Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
npm test
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
npm run build
Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about deployment for more information.
npm run eject
Note: this is a one-way operation. Once you eject, you can’t go back!
If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
Learn More
You can learn more in the Create React App documentation.
To learn React, check out the React documentation.
Code Splitting
This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
Analyzing the Bundle Size
This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
Making a Progressive Web App
This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
Advanced Configuration
This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
Deployment
This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
npm run build fails to minify
This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify