https://github.com/zehsteam/repolib
Library for adding content to R.E.P.O.
https://github.com/zehsteam/repolib
bepinex modding photon-pun repo unity
Last synced: 7 months ago
JSON representation
Library for adding content to R.E.P.O.
- Host: GitHub
- URL: https://github.com/zehsteam/repolib
- Owner: ZehsTeam
- License: mit
- Created: 2025-03-03T04:27:31.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-03-10T18:27:38.000Z (7 months ago)
- Last Synced: 2025-03-10T18:53:29.310Z (7 months ago)
- Topics: bepinex, modding, photon-pun, repo, unity
- Language: C#
- Homepage: https://thunderstore.io/c/repo/p/Zehs/REPOLib/
- Size: 221 KB
- Stars: 1
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project
README
# REPOLib
[](https://github.com/ZehsTeam/REPOLib)
[](https://thunderstore.io/c/repo/p/Zehs/REPOLib/)
[](https://thunderstore.io/c/repo/p/Zehs/REPOLib/)
[](https://www.nuget.org/packages/Zehs.REPOLib)
**Library for adding content to R.E.P.O.**
## Features
- Registering network prefabs.
- Registering valuables.
- Registering items.
- Registering enemies.
- Registering custom chat /commands
- Built-in dev mode commands: Spawn Valuable, Spawn Item
- Fixing audio mixer groups.
- Making networked events.
- Registering features without code using the [REPOLib-Sdk](https://github.com/ZehsTeam/REPOLib-Sdk).
## Usage
Click to expand
Reference [REPOLib](https://www.nuget.org/packages/Zehs.REPOLib) in your project's `.csproj` file.
```
```
Add REPOLib as a dependency to your plugin class.
```cs
[BepInDependency(REPOLib.MyPluginInfo.PLUGIN_GUID, BepInDependency.DependencyFlags.HardDependency)]
```
```cs
[BepInPlugin("You.YourMod", "YourMod", "1.0.0")]
[BepInDependency(REPOLib.MyPluginInfo.PLUGIN_GUID, BepInDependency.DependencyFlags.HardDependency)]
public class YourMod : BaseUnityPlugin
{
// ...
}
```
Network prefabs
Registering a network prefab.
```cs
[BepInPlugin("You.YourMod", "YourMod", "1.0.0")]
[BepInDependency(REPOLib.MyPluginInfo.PLUGIN_GUID, BepInDependency.DependencyFlags.HardDependency)]
public class YourMod : BaseUnityPlugin
{
// ...
private void Awake()
{
// ...
AssetBundle assetBundle = AssetBundle.LoadFromFile("your_assetbundle_file_path");
GameObject prefab = assetBundle.LoadAsset("your_network_prefab");
// Register a network prefab.
REPOLib.Modules.NetworkPrefabs.RegisterNetworkPrefab(prefab);
}
}
```
Valuables
Registering a valuable.
```cs
[BepInPlugin("You.YourMod", "YourMod", "1.0.0")]
[BepInDependency(REPOLib.MyPluginInfo.PLUGIN_GUID, BepInDependency.DependencyFlags.HardDependency)]
public class YourMod : BaseUnityPlugin
{
// ...
private void Awake()
{
// ...
AssetBundle assetBundle = AssetBundle.LoadFromFile("your_assetbundle_file_path");
GameObject prefab = assetBundle.LoadAsset("your_valuable_prefab");
// Register a valuable.
REPOLib.Modules.Valuables.RegisterValuable(prefab);
}
}
```
Registering a valuable to a specific level.
```cs
[BepInPlugin("You.YourMod", "YourMod", "1.0.0")]
[BepInDependency(REPOLib.MyPluginInfo.PLUGIN_GUID, BepInDependency.DependencyFlags.HardDependency)]
public class YourMod : BaseUnityPlugin
{
// ...
private void Awake()
{
// ...
AssetBundle assetBundle = AssetBundle.LoadFromFile("your_assetbundle_file_path");
GameObject prefab = assetBundle.LoadAsset("your_valuable_prefab");
// Valuables Presets:
// "Valuables - Generic"
// "Valuables - Wizard"
// "Valuables - Manor"
// "Valuables - Arctic"
List presets = new List { "Valuables - Wizard" };
// Register a valuable.
REPOLib.Modules.Valuables.RegisterValuable(prefab, presets);
}
}
```
Items
Registering an item.
```cs
[BepInPlugin("You.YourMod", "YourMod", "1.0.0")]
[BepInDependency(REPOLib.MyPluginInfo.PLUGIN_GUID, BepInDependency.DependencyFlags.HardDependency)]
public class YourMod : BaseUnityPlugin
{
// ...
private void Awake()
{
// ...
AssetBundle assetBundle = AssetBundle.LoadFromFile("your_assetbundle_file_path");
Item item = assetBundle.LoadAsset("your_item");
// Register an item.
REPOLib.Modules.Items.RegisterItem(item);
}
}
```
Enemies
Registering an enemy.
```cs
[BepInPlugin("You.YourMod", "YourMod", "1.0.0")]
[BepInDependency(REPOLib.MyPluginInfo.PLUGIN_GUID, BepInDependency.DependencyFlags.HardDependency)]
public class YourMod : BaseUnityPlugin
{
// ...
private void Awake()
{
// ...
AssetBundle assetBundle = AssetBundle.LoadFromFile("your_assetbundle_file_path");
EnemySetup enemy = assetBundle.LoadAsset("your_enemy_setup");
// Register an enemy.
REPOLib.Modules.Enemies.RegisterEnemy(enemy);
}
}
```
Chat commands
Registering a chat /command.
```cs
using REPOLib.Commands;
public static class YourCommand
{
// ...
[CommandInitializer]
public static void Initialize()
{
// Perform any setup or caching
}
[CommandExecution(
"Your Command Name",
"Description of what the command does and how to use it.",
enabledByDefault: true,
requiresDeveloperMode: false,
)]
[CommandAlias("yourcommand")]
[CommandAlias("yourcmd")]
public static void Execute(string args)
{
// ...
}
}
```
Fixing audio mixer groups
Fixing audio mixer groups on a prefab and their children.
```cs
[BepInPlugin("You.YourMod", "YourMod", "1.0.0")]
[BepInDependency(REPOLib.MyPluginInfo.PLUGIN_GUID, BepInDependency.DependencyFlags.HardDependency)]
public class YourMod : BaseUnityPlugin
{
// ...
private void Awake()
{
// ...
AssetBundle assetBundle = AssetBundle.LoadFromFile("your_assetbundle_file_path");
GameObject prefab = assetBundle.LoadAsset("your_prefab");
// Fix the audio mixer groups on a prefab and their children.
REPOLib.Modules.Utilities.FixAudioMixerGroups(prefab);
}
}
```
Registering any features will automatically fix their prefabs audio mixer groups.
Networked events
Creating a networked event.
```cs
using ExitGames.Client.Photon;
using REPOLib.Modules;
[BepInPlugin("You.YourMod", "YourMod", "1.0.0")]
[BepInDependency(REPOLib.MyPluginInfo.PLUGIN_GUID, BepInDependency.DependencyFlags.HardDependency)]
public class YourMod : BaseUnityPlugin
{
// ...
public static NetworkedEvent ExampleEvent;
private void Awake()
{
// ...
ExampleEvent = new NetworkedEvent("My Example Event", HandleExampleEvent);
}
// EventData is from ExitGames.Client.Photon
private static void HandleExampleEvent(EventData eventData)
{
string message = (string)eventData.CustomData;
Debug.Log($"Received message from example event: {message}");
}
}
```
Calling a networked event.
```cs
// The data you are sending through your networked event.
string message = "Hello World!";
// Call networked event on everyone. (This works in singleplayer)
ExampleEvent.RaiseEvent(message, REPOLib.Modules.NetworkingEvents.RaiseAll, SendOptions.SendReliable);
// Call networked event on everyone but yourself. (This works in singleplayer)
ExampleEvent.RaiseEvent(message, REPOLib.Modules.NetworkingEvents.RaiseOthers, SendOptions.SendReliable);
// Call networked event on the master client. (This works in singleplayer)
ExampleEvent.RaiseEvent(message, REPOLib.Modules.NetworkingEvents.RaiseMasterClient, SendOptions.SendReliable);
```
> [!NOTE]
> Registering features (Valuables, Items, Enemies, etc...) automatically registers their prefabs as a network prefab.
> [!NOTE]
> Registering features (Valuables, Items, Enemies, etc...) automatically fixes their prefabs audio mixer groups.
> [!IMPORTANT]
> You should only register network prefabs and features (Valuables, Items, Enemies, etc...) from your plugin's awake function.
> [!TIP]
> You can enable extended logging in the config settings to get more info about features being registered, custom network prefabs being spawned, and more.
## Chat Commands
> [!IMPORTANT]
> You must enable `DeveloperMode` in the config settings to use developer mode commands.
Chat commands currently only work in multiplayer since you need access to the in-game chat to use commands.
This mod comes with a few built-in chat commands:
### 1. Spawn Valuable `/spawnvaluable `
This command will spawn a valuable in front of you.\
Replace `` with the name of the valuable prefab.\
Names are not case-sensitive.\
Example usage: `/spawnvaluable diamond`\
This command has multiple aliases: `/spawnval`, `/sv`\
**This command requires developer mode to be enabled.**\
**This command is host-only!**
### 2. Spawn Item `/spawnitem `
This command will spawn an item in front of you.\
Replace `` with the name of the item or item prefab.\
Names are not case-sensitive.\
Example usage: `/spawnitem gun`\
This command has one alias: `/si`\
**This command requires developer mode to be enabled.**\
**This command is host-only!**
> [!TIP]
> Commands can be enabled/disabled in the config settings.
If you are a mod developer and want to add your own custom chat commands to your mod, check the `Usage > Chat commands` section.
## Contribute
Anyone is free to contribute.
https://github.com/ZehsTeam/REPOLib
To set up the project, copy the `REPOLib.csproj.user.example` file to `REPOLib.csproj.user`. If needed, change the settings found in that file.
## Developer Contact
**Report bugs, suggest features, or provide feedback:**
- **GitHub Issues Page:** [REPOLib](https://github.com/ZehsTeam/REPOLib/issues)
- **Email:** crithaxxog@gmail.com
- **Twitch:** [CritHaxXoG](https://www.twitch.tv/crithaxxog)
- **YouTube:** [Zehs](https://www.youtube.com/channel/UCb4VEkc-_im0h8DKXlwmIAA)
[](https://ko-fi.com/zehsteam)