Add README.md file

This commit is contained in:
sys4-fr 2018-08-20 21:03:44 +02:00
parent fcac41e100
commit 6f98272452
2 changed files with 58 additions and 36 deletions

58
README.md Normal file
View File

@ -0,0 +1,58 @@
# Camera
This mod allow to record flight paths and replay them.
## Dependencies
* default from minetest_game
## License
* Code: MIT
* Models and textures: CC-BY-SA-3.0
##Usage
* /camera : Execute command to start recording.
**While recording**
* use up/down to accelerate/decelerate
* when rotating (mode 2 or 3) the camera up or down on Y axis
* use jump to brake
* use aux1 to stop recording
* use left/right to rotate if looking target is set
* use crouch to stop rotating
Use **/camera play** to play back the last recording. While playing back:
* use aux1 to stop playing back
Use **/camera play <name>** to play a specific recording
Use **/camera save <name> ** to save the last recording
* saved recordings exist through game restarts
Use **/camera list** to show all saved recording
Use **/camera mode <0|2|3> ** to change the velocity behaviour
* 0: Velocity follow mouse (default),
* 2: Velocity locked to player's first look direction with released mouse
* 3: Same that 2 but if you up or down when rotating then looking target will up or down too
Use **/camera look <nil|here|x,y,z> **
* nil: remove looking target,
* here: set looking target to player position,
* x,y,z: Coords to look at
Use **/camera speed <speed> **
* 10 is default speed,
* > 10 decrease speed factor,
* < 10 increase speed factor
>Copyright 2016-2017 - Auke Kok <sofar@foo-projects.org>
>Copyright 2017 - Elijah Duffy <theoctacian@gmail.com>
>Copyright 2017-2018 - sys4 <sys4@free.fr>

View File

@ -1,39 +1,3 @@
--[[
Copyright 2016-2017 - Auke Kok <sofar@foo-projects.org>
Copyright 2017 - Elijah Duffy <theoctacian@gmail.com>
Copyright 2017 - sys4 <sys4@free.fr>
License:
- Code: MIT
- Models and textures: CC-BY-SA-3.0
Usage: /camera
Execute command to start recording.
While recording:
- use up/down to accelerate/decelerate
- when rotating (mode 2 or 3) the camera up or down on Y axis
- use jump to brake
- use aux1 to stop recording
- use left/right to rotate if looking target is set
- use crouch to stop rotating
Use /camera play to play back the last recording. While playing back:
- use aux1 to stop playing back
Use /camera play <name> to play a specific recording
Use /camera save <name> to save the last recording
- saved recordings exist through game restarts
Use /camera list to show all saved recording
Use /camera mode <0|2|3> to change the velocity behaviour
- 0: Velocity follow mouse (default),
- 2: Velocity locked to player's first look direction with released mouse
- 3: Same that 2 but if you up or down when rotating then looking target will up or down too
Use /camera look <nil|here|x,y,z>
- nil: remove looking target,
- here: set looking target to player position,
- x,y,z: Coords to look at
Use /camera speed <speed>
- 10 is default speed,
- > 10 decrease speed factor,
- < 10 increase speed factor
--]]
local recordings = {}
-- [function] Load recordings