-
Notifications
You must be signed in to change notification settings - Fork 8
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
a36d1d2
commit 31853b4
Showing
1 changed file
with
31 additions
and
22 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,37 +1,46 @@ | ||
| ## Welcome to GitHub Pages | ||
| # Elit3D [](https://github.com/christt105/Elit3D/blob/master/LICENSE) | ||
|
|
||
| You can use the [editor on GitHub](https://github.com/christt105/Elit3D/edit/main/docs/index.md) to maintain and preview the content for your website in Markdown files. | ||
|  | ||
|
|
||
| Whenever you commit to this repository, GitHub Pages will run [Jekyll](https://jekyllrb.com/) to rebuild the pages in your site, from the content in your Markdown files. | ||
|  | ||
|  | ||
|  | ||
|
|
||
| ### Markdown | ||
| Elit3D is a tile-based map editor in 3D. Composed of several layers of tiles and 3D objects, it allows you to export the maps in different formats. | ||
|
|
||
| Markdown is a lightweight and easy-to-use syntax for styling your writing. It includes conventions for | ||
| ## Getting Started | ||
|
|
||
| ```markdown | ||
| Syntax highlighted code block | ||
| Elit3D is only tested on Visual Studio 2019 on Windows but the plan is to be compatible with Linux and Mac (minimum Linux) in a future. | ||
|
|
||
| # Header 1 | ||
| ## Header 2 | ||
| ### Header 3 | ||
| ### Installation | ||
|
|
||
| - Bulleted | ||
| - List | ||
| - Clone the repository `git clone https://github.com/christt105/Elit3D` | ||
| - Execute the script `premake5.lua` with `premake/premake5.exe` | ||
| - For Windows - Visual Studio 2019 just execute the `scripts/generate_project.bat` file | ||
|
|
||
| 1. Numbered | ||
| 2. List | ||
| ## Main Goal | ||
|
|
||
| **Bold** and _Italic_ and `Code` text | ||
| The goal of this project is to create a tool to create RPG maps like Pokémon 4th Gen. Will allow to import 3D models, brushes to build terrain, paint planes at differenent heights with tiles and create inclined sprites. e.g. | ||
|
|
||
| [Link](url) and  | ||
| ``` | ||
|  | ||
|
|
||
| For more details see [GitHub Flavored Markdown](https://guides.github.com/features/mastering-markdown/). | ||
| To know more about the features, see the [ROADMAP](https://github.com/christt105/Elit3D/blob/master/ROADMAP.md) file. You can also check the [ClickUp boards](https://share.clickup.com/l/h/4-4678676-1/7e2410f745d66ec) where I put the task I work on. | ||
|
|
||
| ### Jekyll Themes | ||
| ## Author | ||
|
|
||
| Your Pages site will use the layout and styles from the Jekyll theme you have selected in your [repository settings](https://github.com/christt105/Elit3D/settings/pages). The name of this theme is saved in the Jekyll `_config.yml` configuration file. | ||
| This project is made by [christt105](https://github.com/christt105). This project belongs to my final thesis. | ||
|
|
||
| ### Support or Contact | ||
| Repository: [https://github.com/christt105/Elit3D](https://github.com/christt105/Elit3D) | ||
|
|
||
| Having trouble with Pages? Check out our [documentation](https://docs.github.com/categories/github-pages-basics/) or [contact support](https://support.github.com/contact) and we’ll help you sort it out. | ||
| ## Contributing | ||
|
|
||
| You can test the [latest release](https://github.com/christt105/Elit3D/releases/latest) and [report bugs](https://github.com/christt105/Elit3D/issues/new?assignees=&labels=&template=bug_report.md&title=) or [propose features](https://github.com/christt105/Elit3D/issues/new?assignees=&labels=&template=feature_request.md&title=). | ||
| I won't accept any pull request until I finish and present my final thesis to not take any risk with the evaluation. After that, I will be delighted to accept any pull request that improves the project. | ||
|
|
||
| ## Special Thanks | ||
|
|
||
| - [Enric Pérez](https://perezenric.github.io/) for the program icon | ||
|
|
||
| ## License | ||
|
|
||
| This project is licensed under [BSD 2-Clause License](https://github.com/christt105/Elit3D/blob/master/LICENSE) license. |