whosit/yl_cinema
1
0
Fork 0
forked from your-land/yl_cinema
Code Pull Requests Activity

update readme to have current command names

Browse Source
This commit is contained in:
whosit 2024-01-08 20:17:28 +03:00
parent d177542095
commit 6ef568387f
1 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -26,6 +26,8 @@ yl_cinema.settings.enable_craft_bigscreen = true
yl_cinema.settings.enable_craft_bigscreen_recipe = "wool:grey,wool:grey,wool:grey,wool:grey,wool:grey,wool:grey,wool:black,,wool:black"
```
The `save_path` is relative to the directory of the world that's using this mod.
## Modmakers
### API Functions
@ -72,12 +74,19 @@ Returns:
The mod provides two chat commands for showing movies and listing movies:
- `/showmovie <name> <movie>`: Shows the `<movie>` to the specified `<player>`.
- `/listmovies [<searchstring>]`: Lists all movies. Optionally, you can provide a `<searchstring>` to filter the movie list.
- `/movie_list [<searchstring>]`: Lists all movies. Optionally, you can provide a `<searchstring>` to filter the movie list.
- `/movie_show <name> <movie>`: Shows the `<movie>` to the specified `<player>`.
- `/movie_reload [<movie_id>]`: Reload specific `<movie_id>` or all movies, but does not create movie reel items.
- `/movie_imprint <movie>`: Imprints the `<movie>` on the wielded reel.
Default itemstrings:
- `yl_cinema:bigscreen_base` for the rotating screen base (projector)
- `yl_cinema:flatscreen_base` for the static screen base
- `yl_cinema:movie_reel` for the blank movie reel (needs to be imprinted).
## Create a Movie
To create a movie, follow these steps:
To create a new movie, follow these steps:
1. Create a folder with the movie ID as the name. Consult your admin for any required prefixes, suffixes, or other markings.
2. Inside the folder, create a JSON file with the following structure: `{movie_id, name, description, title_texture, version, replay, [{order, texturename, caption, captionposx, captionposy, duration},{...}]}`.