Are you a game dev?
If you’re looking to implement Crowd Control directly into a Unity or Unreal game, please reach out at https://ccgd.warp.world/ for access to our plugins.
Create a game pack
If you are looking to implement Crowd Control for a retro or PC game, check these example.
LUA/Bizhawk: MegaMan2-example.cs
PC Memory Inject: 20XX-example.cs
PC TCPconnect (for use with mods): https://github.com/Die4Ever/deus-ex-randomizer/blob/master/DXRando.cs
In depth documentation is being worked on, but using the above examples and our tech talk: “Build your own Crowd Control Effect Pack” https://youtu.be/wK56OELYvEY. Should get you started on the right path. We also have some other tech talks that explain more how Crowd Control works.
We have also put tougher new options in the SDK to convert CheatEngine and WHC files to the start of a Crowd Control pack. Check out this guide for more info on WHC.
Existing Unity Games
If you’re looking to mod an existing Unity game, you can find our repository for Cuphead here https://github.com/WarpWorld/PC-Cuphead.
More instructions, documentation is coming for this, but the above should give you a good idea of what is involved.
Emulator support
While testing out games, please make sure they are compatible with our currently support emulator list. We do use custom emulators and versions for a reason!
- Bizhawk: 2.8:
We use Bizhawk for: NES, SNES, GB, GBA, N64, Genesis, Game Gear, PS1
We also support SD2SNES/FX PAK Pro and Everdrive N8 Pro. More info here. - Dolphin: Dolphin CC Build
This is our own build of Dolphin with additional support for JIT cache refreshing. - CEMU: 1.21.3
Only this specific version is supported at this time. - PCSX2: 1.6.0
SDK Setup
The SDK is also a work in progress and being updated sometimes daily. Before starting a new project or reporting errors, make sure you are using the latest build of the SDK and have the latest version of the main CC desktop app.
- To get started, extract the 7zip file and open
CrowdControl.SDK.exewhich cannot be run along with the normal desktop app. - From here you can load your .cs from the “Load Pack Source” button and select your pack from the list.
- Select the correct “Game Connector” from the drop down.
- For a Bizhawk game, you want open Bizhawk, load your game and go to Tools >> Lua Console and open our connector at, which is at
%LocalAppData%\Programs\CrowdControl\client\bizhawk\connector.lua
- For a Bizhawk game, you want open Bizhawk, load your game and go to Tools >> Lua Console and open our connector at, which is at
- Then hit Connect on the SDK.
A log will be will be writen in the SDK folder at CrowdControl.SDK.log when you open the client and messages start to come in.
Your working setup for a Bizhawk support game should look something like:
You can execute an effect by selecting it from the SDK effect list and pressing the Play button.
For a PC game, it would be the same setup as above, but without the LUA or Bizhawk additions. The SDK log window should show successful connections if your game was found.
Test effects LIVE or share with a friend
To test effects live, you can use the Crowd Control desktop client! This will let you use your custom game pack to act just like any other offical CC game. You can also share the .ccpak with someone else to play live on Twitch.
- Click “Menu Editor” from the SDK.
- From here you can edit effect descriptions and prices.
- Select the effect and type in the big box to edit the effect description.
- On the right, change the number to change the price of each effect.
- Once it looks good, save the menu!
- This editor is still a work in progress and will offer more options and features soon!
With a yourgame.ccpak in hand, you can now load this into the desktop client or share with a streamer friend to test it out LIVE! From the Crowd Control Desktop Client select the game “Crowd Control Custom Game Pak (Beta)” and then browse to your yourgame.ccpak. You can follow the typical setup instructions at https://crowdcontrol.live/setup for more info.
Support
If you run into any issues or questions, you can look over at our #cc-developer channel in our discord under the Twitch Crowd Control category! We have a good amount of devs working on games, so feel free to just hang out!