JosephFerano/pqtorusknot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.org with project specific details

Browse Source
This commit is contained in:
Joseph Ferano 2023-08-18 15:58:32 +07:00
parent c66b503df6
commit 84e29eb59e
1 changed files with 29 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
README.org
View File

@ -1,39 +1,45 @@
### FPS Scene #+OPTIONS: toc:nil
You can walk around the scene with simple FPS controls. * PQ Torus Knot
Open `scene.html` with an http server, you can use the following;
```python3 -m http.server 8000``` ** About
Unfortunately, elm-reactor has issues with loading obj files so that's why the [[https://ferano.io/3d-fp/][Live Link]]
python server is needed.
![alt text](screenshots/elm-fps.png "FPS Scene") This is an attempt to implement the [[https://en.wikipedia.org/wiki/Torus_knot][PQ Torus Knot]] in the Elm programming
language.
** Showcase
##### Controls ** Keybindings
Mouse - Look Rotation You can increment/decrement P or Q using the keyboard to get different geometry;
WASD - Player movement - Increment P: ~p~
- Increment Q: ~q~
- Decrement P: ~w~
- Decrement Q: ~o~
◀ ▼ ▲ ▶ - Move the Robot ** Building with Elm 0.18.0
To install the binaries manually, follow this short guide; - [[https://sirfitz.medium.com/install-elm-0-18-0-in-2021-3f64ce298801][Install Binaries]]
N and M - Rotate robot left and right If you want to use =npm= instead; - =npm install -g elm@elm0.18.0=
Y and H - Rotate robot arm up and down If you use =npm=, note that you will likely need an older version of Node.js, so
it is recommended to use [[https://github.com/nvm-sh/nvm][nvm]] for that. I have not attempted this method
personally, fyi.
U and J - Rotate robot hand up and down Once you have the Elm compiler, go ahead and run
=elm make Torus.elm=
### PQTorusknot And that should first pull in all the dependencies then generate an =index.html=
file.
Either open up `torus.html`, or use the command `elm-reactor`, if you want to be able to modify the source file and compile; Alternatively, you can use ~elm-reactor~, run the command and open up your browser
to ~https://localhost:8000~ and then click on ~Torus.elm~ in the nice project
webview provided.
https://guide.elm-lang.org/install.html ** License
This project is licensed under the terms of the MIT license. For more
Alternatively, here's the Ellie link information, see the included LICENSE file.
https://ellie-app.com/vVTgpBj77ra1
![alt text](screenshots/elm-knot.png "PQ Torus Knot")