Welcome to our College Organization FPS Game Project repository! This repository contains a Unity project powered by the Aurora FPS Engine and Odin Inspector (Education License). It is intended to serve as a foundation for our organization members to collaborate, experiment, and create a unique AAA-style FPS game.
Our goal with this repository is to provide an accessible starting point for members to dive into game development, learn about FPS mechanics, and push their creativity to the next level.
- A fully integrated Aurora FPS Engine, designed for creating smooth, high-performance FPS mechanics.
- Odin Inspector to boost efficiency and workflow in Unity development.
- Support and documentation to empower your creativity and ensure you can create robust FPS experiences.
- A shared Unity project where collaboration can thrive.
Before working with this repository, make sure you have the appropriate tools installed:
- Unity Editor: This project uses Unity 6000.0.31f1 (or a compatible version of Unity LTS from 2019++). Ensure you have Unity Hub installed to manage your Unity Editor.
- Odin Inspector (Education License): This repository uses Odin Inspector with an education license. This license must only be used in accordance with their terms and for non-commercial purposes.
For detailed guides and documentation related to the assets used in this project, please refer to the links below:
- Aurora FPS Engine Documentation: Aurora FPS Engine Documentation
- Odin Inspector Documentation: Odin Inspector Documentation
Be sure to familiarize yourself with these resources as they will help you maximize the potential of this project.
- Clone this repository to your local machine:
git clone https://github.com/Raion-Community/FPS-Engine.git
- Open the Unity project using Unity Hub.
- Install any pending dependencies (you may be prompted to fulfill asset requirements like the Aurora FPS Engine).
- Explore, create, and collaborate with others in your organization!
- The Aurora FPS Engine and Odin Inspector are licensed assets. They are included here for educational purposes only and should not be used outside this project without a valid license.
- Per Odin's Education License guidelines, this repository and the work created here must not be used for commercial purposes.
- If you modify or distribute this project internally within your organization, ensure these license rules are adhered to.
We encourage members of the organization to actively contribute to the development! Here's how you can get involved:
- Fork the repository.
- Create a branch for your feature or fix:
git checkout -b feature-name. - Make your changes and commit:
git commit -m "Description of changes". - Push to your branch:
git push origin feature-name. - Open a pull request to the main repository for review.
If you encounter any issues while working on this project, please reach out to the repo maintainer or check out the documentation linked above.
Special thanks to the developers of Aurora FPS Engine and Odin Inspector for providing these incredible tools that make game development more manageable and enjoyable.
The uploader of this project affirms that the Aurora FPS Engine was legally purchased through the Unity Asset Store.
All developers who use this project for educational purposes are strongly encouraged to purchase their own copy of the Aurora FPS Engine through the Unity Asset Store. By doing so, we support the developers of this incredible asset and their hard work. We do not support or condone any illegal usage, duplication, or redistribution of this product in violation of its licensing terms.
If at any point the owner of the Aurora FPS Engine or any other included asset requests the removal of this repository, the maintainers will respect their decision and take the repository down promptly without contest.