Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/n1md7/three-boilerplate
ThreeJS FPS boilerplate, basic character movements, shooting animations, etc.
https://github.com/n1md7/three-boilerplate
3d boilerplate electron first-person first-person-shooter fps game setup template threejs typescript web
Last synced: 22 days ago
JSON representation
ThreeJS FPS boilerplate, basic character movements, shooting animations, etc.
- Host: GitHub
- URL: https://github.com/n1md7/three-boilerplate
- Owner: n1md7
- Created: 2023-03-27T15:54:18.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-08-09T21:48:14.000Z (over 1 year ago)
- Last Synced: 2024-11-22T01:42:05.608Z (3 months ago)
- Topics: 3d, boilerplate, electron, first-person, first-person-shooter, fps, game, setup, template, threejs, typescript, web
- Language: TypeScript
- Homepage: https://n1md7.github.io/three-boilerplate/
- Size: 33.8 MB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ThreeJS FPS boilerplate
Technologies used
- Vite
- Vitest
- Typescript
- Electron
Features
- FPS controls (WASD)
- Orbit controls (Mouse)
- Object collisions
- Shooting animations (for each weapon)
- Player flashlight (F)
- Multiple weapons (Pistol, Shotgun, Rifle, etc)
- Sounds (WIP)
- Particle effects (WIP)
- UI (WIP)
## How to run
```bash
# Browser
$ npm run dev
# Build - Transpile to JS
$ npm run build
# Electron
$ npm run electron
# or
$ npm run start
# Build binaries
$ npm run make
$ npm run package
```
### Workflow actions
Once it is cloned make sure you enable permissions
`Settings > Actions > General` make sure in **Workflow permissions** **Read and Write** is granted
### Configure template source and update change
```bash
# Add remote source
git remote add template https://github.com/n1md7/three-boilerplate.git
# Pull changes
git pull template master
# Merge into the current branch
git merge template/master --allow-unrelated-histories
```