-
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
JamesOrson
authored and
JamesOrson
committed
Apr 14, 2021
0 parents
commit 38f9b55
Showing
80 changed files
with
36,745 additions
and
0 deletions.
There are no files selected for viewing
Empty file.
Large diffs are not rendered by default.
Oops, something went wrong.
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 |
---|---|---|
@@ -0,0 +1,79 @@ | ||
# Komodo | ||
[Documentation](https://exokomodo.github.io/KomodoNim/komodo.html) | ||
|
||
## Setup | ||
|
||
### Windows | ||
|
||
#### Install Scoop | ||
Follow the instructions found on [Scoop's website](https://scoop.sh), or run the following commmands: | ||
```PowerShell | ||
iwr -useb get.scoop.sh | iex | ||
``` | ||
|
||
#### Install Nim | ||
Install nim with | ||
```PowerShell | ||
scoop install nim | ||
``` | ||
|
||
#### Raylib Setup | ||
Copy the libraries found in the project's `libs/raylib/windows` directory to `C:\Windows\System32`. | ||
|
||
### Mac OS | ||
|
||
#### Install choosenim | ||
Follow the install instructions found on [choosenim's repo](https://github.com/dom96/choosenim), or run the following commands: | ||
```bash | ||
curl https://nim-lang.org/choosenim/init.sh -sSf | sh | ||
``` | ||
You will need to update your path in your `.bashrc`: | ||
```bash | ||
export PATH=~/.nimble/bin:$PATH | ||
``` | ||
|
||
#### Install Nim | ||
Install nim with | ||
```bash | ||
choosenim stable | ||
``` | ||
|
||
#### Raylib Setup | ||
Install raylib with | ||
```bash | ||
brew install raylib | ||
``` | ||
|
||
### Linux | ||
|
||
#### Install choosenim | ||
Follow the install instructions found on [choosenim's repo](https://github.com/dom96/choosenim), or run the following commands: | ||
```bash | ||
curl https://nim-lang.org/choosenim/init.sh -sSf | sh | ||
``` | ||
You will need to update your path in your `.bashrc`: | ||
```bash | ||
export PATH=~/.nimble/bin:$PATH | ||
``` | ||
|
||
#### Install Nim | ||
Install nim with | ||
```bash | ||
choosenim stable | ||
``` | ||
|
||
#### Raylib Setup | ||
Either copy the `libraylib.so` file from `libs/raylib/linux` into `/usr/local/lib`, or follow the install instructions found on [raylib's repo wiki](https://github.com/raysan5/raylib/wiki/Working-on-GNU-Linux) to build from source and install like so: | ||
```bash | ||
cd /tmp | ||
git clone https://github.com/raysan5/raylib.git raylib | ||
cd raylib/src/ | ||
make PLATFORM=PLATFORM_DESKTOP RAYLIB_LIBTYPE=SHARED | ||
sudo make install RAYLIB_LIBTYPE=SHARED | ||
``` | ||
|
||
## Important Links | ||
* [raylib bindings](https://github.com/Guevara-chan/Raylib-Forever) | ||
* [raylib cheatsheet](https://www.raylib.com/cheatsheet/cheatsheet.html) | ||
* [raylib releases](https://github.com/raysan5/raylib/releases) | ||
* [IUP documentation](http://webserver2.tecgraf.puc-rio.br/iup) |
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
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 |
---|---|---|
@@ -0,0 +1,139 @@ | ||
<?xml version="1.0" encoding="utf-8" ?> | ||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" | ||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | ||
<!-- This file is generated by Nim. --> | ||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> | ||
<head> | ||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> | ||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0"> | ||
|
||
<!-- Favicon --> | ||
<link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/> | ||
<link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII="> | ||
|
||
<!-- Google fonts --> | ||
<link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/> | ||
<link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/> | ||
|
||
<!-- CSS --> | ||
<title>komodo</title> | ||
<link rel="stylesheet" type="text/css" href="nimdoc.out.css"> | ||
|
||
<script type="text/javascript" src="dochack.js"></script> | ||
|
||
<script type="text/javascript"> | ||
function main() { | ||
var pragmaDots = document.getElementsByClassName("pragmadots"); | ||
for (var i = 0; i < pragmaDots.length; i++) { | ||
pragmaDots[i].onclick = function(event) { | ||
// Hide tease | ||
event.target.parentNode.style.display = "none"; | ||
// Show actual | ||
event.target.parentNode.nextElementSibling.style.display = "inline"; | ||
} | ||
} | ||
|
||
const toggleSwitch = document.querySelector('.theme-switch input[type="checkbox"]'); | ||
function switchTheme(e) { | ||
if (e.target.checked) { | ||
document.documentElement.setAttribute('data-theme', 'dark'); | ||
localStorage.setItem('theme', 'dark'); | ||
} else { | ||
document.documentElement.setAttribute('data-theme', 'light'); | ||
localStorage.setItem('theme', 'light'); | ||
} | ||
} | ||
|
||
toggleSwitch.addEventListener('change', switchTheme, false); | ||
|
||
const currentTheme = localStorage.getItem('theme') ? localStorage.getItem('theme') : null; | ||
if (currentTheme) { | ||
document.documentElement.setAttribute('data-theme', currentTheme); | ||
|
||
if (currentTheme === 'dark') { | ||
toggleSwitch.checked = true; | ||
} | ||
} | ||
} | ||
</script> | ||
|
||
</head> | ||
<body onload="main()"> | ||
<div class="document" id="documentId"> | ||
<div class="container"> | ||
<h1 class="title">komodo</h1> | ||
<div class="row"> | ||
<div class="three columns"> | ||
<div class="theme-switch-wrapper"> | ||
<label class="theme-switch" for="checkbox"> | ||
<input type="checkbox" id="checkbox" /> | ||
<div class="slider round"></div> | ||
</label> | ||
<em>Dark Mode</em> | ||
</div> | ||
<div id="global-links"> | ||
<ul class="simple"> | ||
<li> | ||
<a href="theindex.html">Index</a> | ||
</li> | ||
</ul> | ||
</div> | ||
<div id="searchInputDiv"> | ||
Search: <input type="text" id="searchInput" | ||
onkeyup="search()" /> | ||
</div> | ||
<div> | ||
Group by: | ||
<select onchange="groupBy(this.value)"> | ||
<option value="section">Section</option> | ||
<option value="type">Type</option> | ||
</select> | ||
</div> | ||
<ul class="simple simple-toc" id="toc-list"> | ||
<li> | ||
<a class="reference reference-toplevel" href="#6" id="56">Imports</a> | ||
<ul class="simple simple-toc-section"> | ||
|
||
</ul> | ||
</li> | ||
<li> | ||
<a class="reference reference-toplevel" href="#19" id="69">Exports</a> | ||
<ul class="simple simple-toc-section"> | ||
|
||
</ul> | ||
</li> | ||
|
||
</ul> | ||
|
||
</div> | ||
<div class="nine columns" id="content"> | ||
<div id="tocRoot"></div> | ||
|
||
<p class="module-desc"></p> | ||
<div class="section" id="6"> | ||
<h1><a class="toc-backref" href="#6">Imports</a></h1> | ||
<dl class="item"> | ||
<a class="reference external" href="komodo/game.html">komodo/game</a>, <a class="reference external" href="komodo/logging.html">komodo/logging</a> | ||
</dl></div> | ||
<div class="section" id="19"> | ||
<h1><a class="toc-backref" href="#19">Exports</a></h1> | ||
<dl class="item"> | ||
<a href="komodo/game.html#executeOnSystems,Game,proc(System)"><span class="Identifier">executeOnSystems</span></a>, <a href="komodo/game.html#title=,Game,string"><span class="Identifier">title=</span></a>, <a href="komodo/game.html#screenSize,Game"><span class="Identifier">screenSize</span></a>, <a href="komodo/game.html#registerComponent,Game,Component"><span class="Identifier">registerComponent</span></a>, <a href="komodo/game.html#clearColor=,Game,Color"><span class="Identifier">clearColor=</span></a>, <a href="komodo/game.html#registerEntity,Game,Entity"><span class="Identifier">registerEntity</span></a>, <a href="komodo/game.html#deregisterComponent,Game,Component"><span class="Identifier">deregisterComponent</span></a>, <a href="komodo/game.html#clearColor,Game"><span class="Identifier">clearColor</span></a>, <a href="komodo/game.html#shouldCloseAudio=,Game,bool"><span class="Identifier">shouldCloseAudio=</span></a>, <a href="komodo/game.html#CommandKind"><span class="Identifier">CommandKind</span></a>, <a href="komodo/game.html#run,Game,ptr.Channel[CommandKind]"><span class="Identifier">run</span></a>, <a href="komodo/game.html#title,Game"><span class="Identifier">title</span></a>, <a href="komodo/game.html#deregisterEntity,Game,Entity"><span class="Identifier">deregisterEntity</span></a>, <a href="komodo/game.html#deregisterSystem,Game,System"><span class="Identifier">deregisterSystem</span></a>, <a href="komodo/game.html#run,Game"><span class="Identifier">run</span></a>, <a href="komodo/game.html#registerSystem,Game,System"><span class="Identifier">registerSystem</span></a>, <a href="komodo/game.html#quit,Game"><span class="Identifier">quit</span></a>, <a href="komodo/game.html#setClearColor,Game,Color"><span class="Identifier">setClearColor</span></a>, <a href="komodo/game.html#camera,Game"><span class="Identifier">camera</span></a>, <a href="komodo/game.html#isRunning,Game"><span class="Identifier">isRunning</span></a>, <a href="komodo/game.html#Game"><span class="Identifier">Game</span></a>, <a href="komodo/game.html#shouldCloseAudio,Game"><span class="Identifier">shouldCloseAudio</span></a>, <a href="komodo/game.html#newGame,string"><span class="Identifier">newGame</span></a>, <a href="komodo/logging.html#logDebug,string"><span class="Identifier">logDebug</span></a>, <a href="komodo/logging.html#logError,string"><span class="Identifier">logError</span></a>, <a href="komodo/logging.html#logInfo,string"><span class="Identifier">logInfo</span></a> | ||
</dl></div> | ||
|
||
</div> | ||
</div> | ||
|
||
<div class="row"> | ||
<div class="twelve-columns footer"> | ||
<span class="nim-sprite"></span> | ||
<br/> | ||
<small style="color: var(--hint);">Made with Nim. Generated: 2021-04-14 03:16:50 UTC</small> | ||
</div> | ||
</div> | ||
</div> | ||
</div> | ||
|
||
</body> | ||
</html> |
Oops, something went wrong.