-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
d1cb3c3
commit 02dbe9b
Showing
1 changed file
with
10 additions
and
64 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,70 +1,16 @@ | ||
| ----------------------------------- | ||
| # NeXUS-raylib | ||
|
|
||
| _DISCLAIMER:_ | ||
| A work in progress port of a work in progress fantasy console. Basically | ||
| porting NeXUS to raylib so we don't have to deal with LOVE2D overhead. | ||
|
|
||
| Welcome to **raylib game template**! | ||
| The system font is [Matchup Pro][] by [Eeve Somepx][], used with attribution | ||
| because holy cow it's a really good font go support Eeve you won't regret it. | ||
|
|
||
| This template provides a base structure to start developing a small raylib game in plain C. The repo is also pre-configured with a default `LICENSE` (zlib/libpng) and a `README.md` (this one) to be properly filled by users. Feel free to change the LICENSE as required. | ||
| ## To run | ||
|
|
||
| All the sections defined by `$(Data to Fill)` are expected to be edited and filled properly. It's recommended to delete this disclaimer message after editing this `README.md` file. | ||
| Don't. (Right now.) | ||
|
|
||
| This template has been created to be used with raylib (www.raylib.com) and it's licensed under an unmodified zlib/libpng license. | ||
| Use the solution in the `projects/VS2022` directory to build if on Windows, otherwise use `make` in the `src` directory. | ||
|
|
||
| _Copyright (c) 2014-2024 Ramon Santamaria ([@raysan5](https://twitter.com/raysan5))_ | ||
|
|
||
| ----------------------------------- | ||
| ## Getting Started with this template | ||
| - After extracting the zip, the parent folder `raylib-game-template` should exist in the same directory as `raylib` itself. So your file structure should look like this: | ||
| - Some parent directory | ||
| - `raylib` | ||
| - the contents of https://github.com/raysan5/raylib | ||
| - `raylib-game-template` | ||
| - this `README.md` and all other raylib-game-template files | ||
| - If using Visual Studio, open projects/VS2022/raylib-game-template.sln | ||
| - Select on `raylib_game` in the solution explorer, then in the toolbar at the top, click `Project` > `Set as Startup Project` | ||
| - Now you're all set up! Click `Local Windows Debugger` with the green play arrow and the project will run. | ||
|
|
||
| ## $(Game Title) | ||
|
|
||
|  | ||
|
|
||
| ### Description | ||
|
|
||
| $(Your Game Description) | ||
|
|
||
| ### Features | ||
|
|
||
| - $(Game Feature 01) | ||
| - $(Game Feature 02) | ||
| - $(Game Feature 03) | ||
|
|
||
| ### Controls | ||
|
|
||
| Keyboard: | ||
| - $(Game Control 01) | ||
| - $(Game Control 02) | ||
| - $(Game Control 03) | ||
|
|
||
| ### Screenshots | ||
|
|
||
| _TODO: Show your game to the world, animated GIFs recommended!._ | ||
|
|
||
| ### Developers | ||
|
|
||
| - $(Developer 01) - $(Role/Tasks Developed) | ||
| - $(Developer 02) - $(Role/Tasks Developed) | ||
| - $(Developer 03) - $(Role/Tasks Developed) | ||
|
|
||
| ### Links | ||
|
|
||
| - YouTube Gameplay: $(YouTube Link) | ||
| - itch.io Release: $(itch.io Game Page) | ||
| - Steam Release: $(Steam Game Page) | ||
|
|
||
| ### License | ||
|
|
||
| This game sources are licensed under an unmodified zlib/libpng license, which is an OSI-certified, BSD-like license that allows static linking with closed source software. Check [LICENSE](LICENSE) for further details. | ||
|
|
||
| $(Additional Licenses) | ||
|
|
||
| *Copyright (c) $(Year) $(User Name) ($(User Twitter/GitHub Name))* | ||
| [Matchup Pro]: https://somepx.itch.io/humble-fonts-free "links to the Humble Fonts Free collection which contains Matchup Pro" | ||
| [Eeve Somepx]: https://twitter.com/somepx |