https://github.com/kronyxgames/kronyx-gitignore
The official Kronyx Engines gitignore public template
https://github.com/kronyxgames/kronyx-gitignore
github gitignore template
Last synced: 11 months ago
JSON representation
The official Kronyx Engines gitignore public template
- Host: GitHub
- URL: https://github.com/kronyxgames/kronyx-gitignore
- Owner: kronyxgames
- License: mit
- Created: 2025-08-03T15:33:47.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-08-03T15:43:44.000Z (11 months ago)
- Last Synced: 2025-08-03T17:31:16.459Z (11 months ago)
- Topics: github, gitignore, template
- Homepage: https://kronyxengines.com
- Size: 10.7 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Kronyx Engines .gitignore
This repository provides the official `.gitignore` template for **Kronyx Engines**, our in-house game engine based on the [Bevy](https://bevyengine.org/) game engine and built primarily with Rust.
## Purpose
The purpose of this `.gitignore` file is to ensure consistent exclusion of unnecessary files across all Kronyx Engines projects, keeping repositories clean and focused on source files and essential assets.
## What does it cover?
- **Rust-specific build outputs:** such as `/target/` directory and `Cargo.lock` files.
- **Bevy assets and cache files:** common temporary files related to game assets.
- **Blender temp and backup files:** to ignore backup files and autosaves generated during asset creation.
- **IDE and Editor files:** for VSCode, JetBrains IDEs, and other editors to avoid committing user-specific settings.
- **Operating system files:** like `.DS_Store` on macOS and `Thumbs.db` on Windows.
- **Common temporary and backup files:** editor swap files, logs, build intermediates, etc.
## How to use
1. **Copy** the `.gitignore` file from this repository into the root directory of your Kronyx Engine project.
2. **Customize** it if necessary to fit your project's specific requirements.
3. **Commit** the `.gitignore` file as part of your project's source control.
## Why use this template?
Using a shared `.gitignore` template across all Kronyx Engine projects ensures:
- Cleaner git history and smaller repositories.
- Reduced risk of accidentally committing build artifacts or sensitive user files.
- Improved onboarding experience for developers by having a standard setup.
## Contribution
Contributions to improve this `.gitignore` template are welcome! Feel free to submit a pull request if you notice missing patterns or want to optimize it further.
*This `.gitignore` is maintained by Kronyx Games Studios and tailored for the Kronyx Engines ecosystem.*
---
## Licence
This Github repo use the MIT licence. See the ´./licence´ file for more information..