Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/skerwe/generator-game-generic
Game development project structure Yeoman generator
https://github.com/skerwe/generator-game-generic
folder-structure game-development yeoman-generator
Last synced: 11 days ago
JSON representation
Game development project structure Yeoman generator
- Host: GitHub
- URL: https://github.com/skerwe/generator-game-generic
- Owner: Skerwe
- License: mit
- Created: 2019-01-13T10:57:12.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-07-05T07:24:20.000Z (4 months ago)
- Last Synced: 2024-10-25T16:36:42.974Z (13 days ago)
- Topics: folder-structure, game-development, yeoman-generator
- Language: JavaScript
- Homepage: https://npmjs.com/package/generator-game-generic
- Size: 2.13 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Generic Game Folder Structure Generator
[![NPM version][npm-image]][npm-url]
[](https://github.com/Skerwe/generator-game-generic/actions/workflows/npm-build-test.yml)
[![Coverage percentage][coveralls-image]][coveralls-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]
> A practical folder structure for your next game development project. These folders organize your game project in a logical structure based on resource type.
```folders
.
├── assets/
├── docs/
├── game/
│ ├── cordova/
│ ├── html5/
│ ├── linux/
│ ├── nwjs/
│ ├── scirra-arcade/
│ └── windows/
├── source/
├── .editorconfig
├── .gitattributes
├── .gitignore
├── README.md
└── LICENSE
```
## Cloning the repository
This project uses Git submodules, you will need to clone the project with the submodule:
```bash
git clone [email protected]:indiesagtewerke/codename-project-structure.git --recurse-submodules
```
## Installation
First, install [Yeoman](http://yeoman.io) and generator-game-generic using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)).
```bash
npm install -g yo
npm install -g generator-game-generic
```
Then generate your new project:
```bash
yo game-generic
```
or
```bash
yo game-generic my-game-codename
```
## Versioning configuration
After creating your game project folder structure, you will need to [configure version control for your preferred game engine or framework](generators/app/templates/source/README.md)
Currently included are `.gitignore` and `.gitattribute` files for **Unity**, **Unreal Engine** and **Construct 2/3**.
## This project was built with
* [Yeoman](http://yeoman.io/): The web's scaffolding tool
* [Game Development Project Structure](https://bitbucket.org/indiesagtewerke/codename-project-structure/src/master/)
## License
This project is licensed under the MIT License -- see the [LICENSE](LICENSE) file for details
[npm-image]: https://badge.fury.io/js/generator-game-generic.svg
[npm-url]: https://npmjs.org/package/generator-game-generic
[coveralls-image]: https://coveralls.io/repos/Skerwe/generator-game-generic/badge.svg
[coveralls-url]: https://coveralls.io/r/Skerwe/generator-game-generic
[snyk-image]: https://snyk.io/test/github/Skerwe/generator-game-generic/badge.svg
[snyk-url]: https://snyk.io/test/github/Skerwe/generator-game-generic