mirror of
https://github.com/thegeneralist01/Scene-Manager-DevRepo
synced 2026-03-07 12:29:55 +01:00
Update README.md
This commit is contained in:
parent
56a770b718
commit
b6131c0b0e
1 changed files with 23 additions and 4 deletions
27
README.md
27
README.md
|
|
@ -1,17 +1,17 @@
|
||||||
# Scene Manager
|
# Scene Manager
|
||||||
|
|
||||||
## INSTALLATION
|
## INSTALLATION
|
||||||
Drag and drop the contents from within the downloaded GTA V folder into where your GTA V is installed.
|
Drag and drop the contents from within the downloaded GTA V folder into where your GTA V is installed. Ensure the plugin is set to load on startup in the RagePluginHook settings, or load it manually via the in-game console.
|
||||||

|

|
||||||
|
|
||||||
## GET SUPPORT AND REPORT PROBLEMS
|
## GET SUPPORT AND REPORT PROBLEMS
|
||||||
For the fastest support, [join my Discord](https://discord.gg/cUQaTNQ) and ask your question in the **correct category/channel**. For slower support, [use this thread on the LSPDFR forums](https://www.lcpdfr.com/forums/topic/107730-richs-plugin-support-thread/).
|
For the fastest support, [join my Discord](https://discord.gg/cUQaTNQ) and ask your question in the **correct category/channel**. For slower support, [use this thread on the LSPDFR forums](https://www.lcpdfr.com/forums/topic/107730-richs-plugin-support-thread/).
|
||||||
|
|
||||||
## GET SUPPORT AND REPORT PROBLEMS
|
|
||||||
For the fastest support, [join my Discord](https://discord.gg/cUQaTNQ) and ask your question in the **correct category/channel**. For slower support, [use this thread on the LSPDFR forums](https://www.lcpdfr.com/forums/topic/107730-richs-plugin-support-thread/).
|
|
||||||
|
|
||||||
## HOW TO USE SCENE MANAGER
|
## HOW TO USE SCENE MANAGER
|
||||||
### Using the Menus:
|
### Using the Menus:
|
||||||
|
|
||||||
|
The default keybind to open the menu is Left Shift and T.
|
||||||
|
|
||||||
Menu options with gold colored text are selectable, which means when you select these menu items, something will happen (opening a new menu, adding a waypoint, placing a barrier, etc). Menu options with white colored text are interactable (can be scrolled through, for example), but nothing will happen if you try to select them.
|
Menu options with gold colored text are selectable, which means when you select these menu items, something will happen (opening a new menu, adding a waypoint, placing a barrier, etc). Menu options with white colored text are interactable (can be scrolled through, for example), but nothing will happen if you try to select them.
|
||||||
|
|
||||||

|

|
||||||
|
|
@ -61,6 +61,25 @@ Menu options with gold colored text are selectable, which means when you select
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
## Using the API
|
||||||
|
For plugin developers who would like to utilize the Scene Manager API, you must first resolve the assembly in your plugin since Scene Manager is not in the GTA V root directory. Including the follwing code when your plugin is initialized should work:
|
||||||
|
|
||||||
|
```
|
||||||
|
private static Assembly OnAssemblyResolve(object sender, ResolveEventArgs args)
|
||||||
|
{
|
||||||
|
if (args.Name.StartsWith("SceneManager"))
|
||||||
|
{
|
||||||
|
return Assembly.Load(File.ReadAllBytes(@"Plugins\SceneManager.dll"));
|
||||||
|
}
|
||||||
|
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
As of V2.3.3, the API includes two functions: `LoadPathsFromFile` and `DeleteLoadedPaths`. `LoadPathsFromFile` has one mandatory parameter, the file name for the path, and an optional parameter where you can specify the file path location. Be default, all paths are loaded from `SceneManager/Saved Paths`. When you load paths through the API, they are loaded using a separate instance of Scene Manager, so you cannot interact with them using the traditional Scene Manager menu.
|
||||||
|
|
||||||
|
When you're finished with the path, you should call `DeleteLoadedPaths` method to clean everything up.
|
||||||
|
|
||||||
## CREDITS
|
## CREDITS
|
||||||
* Author: Rich
|
* Author: Rich
|
||||||
* Additional credit: PNWParksFan for code assistance and extensive testing, Sereous, OJdoesIt, Vincentsgm, EchoWolf, FactionsBrutus
|
* Additional credit: PNWParksFan for code assistance and extensive testing, Sereous, OJdoesIt, Vincentsgm, EchoWolf, FactionsBrutus
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue