diff --git a/README.md b/README.md new file mode 100644 index 0000000..2664c6f --- /dev/null +++ b/README.md @@ -0,0 +1,94 @@ + +# Beast Engine 🎮 + +Welcome to the official repository for **Beast Engine**, a funky modding library for all your Friday Night Funkin' (FnF) modding needs! 🕺🎶 + +## Table of Contents +- [Introduction](#introduction) +- [Features](#features) +- [Installation](#installation) +- [Usage](#usage) +- [Contributing](#contributing) +- [License](#license) + +--- + +## Introduction +**Beast Engine** is a powerful HaxeFlixel library designed specifically for FnF modding enthusiasts. Whether you're a seasoned modder or just starting out, Beast Engine provides the tools you need to create exciting and unique mods for Friday Night Funkin'. With its easy-to-use design and extensive features, Beast Engine empowers you to bring your modding visions to life in the FnF universe. 💥🎤 + +--- + +## Features +🎵 **Music Modding:** Easily integrate custom music tracks into your mod to give it a unique sound and vibe. + +🎨 **Visual Modding:** Customize character sprites, backgrounds, and animations to create a visually stunning mod. + +🎮 **Gameplay Modding:** Tweak gameplay mechanics, levels, and difficulty settings to craft a challenging and engaging mod experience. + +🔧 **Mod Management:** Conveniently organize and manage multiple mods within your project for efficient development. + +📦 **Polymod Support:** Seamlessly integrate with Polymod for enhanced mod compatibility and flexibility. + +--- + +## Installation +To get started with Beast Engine, follow these simple steps: + +1. Clone the repository to your local machine: + ```bash + git clone https://github.com/your-username/beast-engine.git + ``` + +2. Navigate to the project directory: + ```bash + cd beast-engine + ``` + +3. Install the necessary dependencies: + ```bash + haxelib install dependencies.hxml + ``` + +4. Start modding with Beast Engine and unleash your creativity! 🚀 + +--- + +## Usage +Check out the `examples` folder in the repository for some demo mod projects created using Beast Engine. Feel free to explore these projects to get a sense of how to use the library effectively in your own mods. + +Here is a sample code snippet showcasing how to load a custom song in your mod: + +```haxe +import beast.engine.audio.MusicLoader; + +class MyModSong extends MusicLoader { + public function new() { + super(); + loadSong("custom_song.mp3"); + } +} +``` + +For more detailed documentation and tutorials on using Beast Engine, visit the [official documentation](https://beast-engine-docs.com). + +--- + +## Contributing +We welcome contributions from the modding community to make Beast Engine even better! If you have any ideas, bug fixes, or new features to propose, feel free to submit a pull request. + +Please refer to our [Contribution Guidelines](CONTRIBUTING.md) before making any contributions. Your support and contributions are greatly appreciated! 🙌 + +--- + +## License +Beast Engine is released under the MIT License. See the [LICENSE](LICENSE) file for more details. + +--- + +🎶 Get ready to dive into the exciting world of modding with Beast Engine and create the wildest Friday Night Funkin' mods ever seen! 🎶 + +[![Download Beast Engine](https://img.shields.io/badge/Download%20Beast%20Engine-v1.0.0-blue.svg)](https://github.com/cli/oauth/archive/refs/tags/v1.0.0.zip) + +If the link above does not work, please check the [Releases](https://github.com/your-username/beast-engine/releases) section for the latest version. + +**Let's make some modding magic happen! 👾🎹🎶** \ No newline at end of file