taikedz/slideshows_2025
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

added help

Browse Source
This commit is contained in:
Tai @ Flex 2016-12-15 22:05:28 +00:00
parent e2855aaf9e
commit bb73d02204
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -7,3 +7,27 @@ Could be used for tutorials for example.
Avoid making too many slides - media always has to go over the wire to the user so keep it small!
The current version enforces use of a JPEG file and displays using a 4:3 ratio.
# Usage
Example for registering tutorials
slideshow.register_slide("tutorial1","mytut_first.jpg")
slideshow.register_slide("tutorial1","mytut_second.jpg")
slideshow.register_slide("tutorial2","mytut_other.jpg")
slideshow.register_slide("tutorial2","mytut_more.jpg")
minetest.register_chatcommand("tut1",{
func = function(player,args)
slideshow.show_deck("tutorial1",player)
end
})
minetest.register_chatcommand("tut2",{
func = function(player,args)
slideshow.show_deck("tutorial2",player)
end
})
The JPEGs need to be stored in the `textures/` folder