https://github.com/Myriadn/Funabulist
https://github.com/Myriadn/Funabulist
love2d-framework
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/Myriadn/Funabulist
- Owner: Myriadn
- Created: 2025-08-02T10:16:56.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-08-02T16:21:38.000Z (10 months ago)
- Last Synced: 2025-08-02T18:30:57.847Z (10 months ago)
- Topics: love2d-framework
- Language: Lua
- Homepage:
- Size: 134 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Compfest Edging
## Overview
Later.
## Project Structure
```lua
compfest-edging/
├── assets/ -- Game assets
│ ├── fonts/ -- Font files
│ ├── images/ -- Image files and sprites
│ └── sounds/ -- Sound effects and music
├── conf/ -- Configuration files
├── lib/ -- Third-party libraries
├── src/ -- Source code
│ ├── entities/ -- Game entities
│ ├── states/ -- Game states
│ ├── systems/ -- Game systems
│ └── utils/ -- Utility functions
├── conf.lua -- Love2D configuration
├── main.lua -- Entry point
└── README.md -- This file
```
## Getting Started
### Prerequisites
- [Love2D](https://love2d.org/) version 11.5 or later
## Development Guidelines
### Code Style
- Use PascalCase for class names
- Use camelCase for variables and functions
- Use 4 spaces for indentation
- Add comments to explain complex logic
- Separate code into logical modules
### Git Workflow
1. Create a branch for your feature: `git checkout -b feature/feature-name`
2. Make your changes
3. Commit with meaningful messages: `git commit -m "Add feature X"`
4. Push to your branch: `git push origin feature/feature-name`
5. Create a pull request
## Adding New Content
### Adding a New Entity
1. Create a new file in `src/entities/`
2. Inherit from the base Entity class
3. Implement required methods: `update()`, `draw()`, etc.
### Adding a New Game State
1. Create a new file in `src/states/`
2. Inherit from the base gameState class
3. Implement required methods: `load()`, `update()`, `draw()`, etc.
### Adding Assets
1. Place assets in their respective folders under `assets/`
2. Load assets in the appropriate game state
## License
Later..
## Contributors
[@Myriadn](https://github.com/Myriadn), [@seymourrisey](https://github.com/seymourrisey), [@azwinrx](https://github.com/azwinrx)