splitscreen-me/splitscreenme-www

SplitScreen.Me - Website, docs & tutorials ℹ️

splitscreenme-www's Issues

🐛 what is nucleus-coop.github.io ?

I have searched through the issues and didn't find my problem.

• Confirm

Bug description

Website "https://nucleus-coop.github.io/docs/FAQ/" is linking in few places to splitscreenme, but if I understand correctly "https://www.splitscreen.me/" is official website. Is it website of one of the old forks? I would suggest creating some sort of "history" section that would prevent confusion for new users.

Debug Log

Possible fixes or solutions

No response

Additional information

No response

Add PR templates

Add PR templates for bugfixes, feature requests, etc...
All new pull-requests should be assigned to the @SplitScreen-Me/splitscreenme-www team if possible

https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates#pull-request-templates

Step by step guide to making a basic script in Doc

A step by step noob friendly guide on how to make a handler/script for NucleusCoop.

Perhaps it could be for an already released handler, just a step by step process on how to find the right mutex to kill, process name, split gamepads, different focus functions, and the play() function, etc...

It doesn't need to go much in depth, just showing the process of making a simple script from start to finish is plenty enough.

It could be either a video guide, or a written guide.

The guide can be written in markdown, and placed here: https://github.com/SplitScreen-Me/splitscreenme-www/blob/master/docs/create-handlers.md

Issue forms aren't working

Folder needs to be renamed to .github/ISSUE_TEMPLATE

Add new issue form for Meta/Repository

Add a new issue form for the Meta/Repository label.

So that people can easily request changes and additions to the repo itself.

https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms

Add logging on the server for each deployment

Move api documentation from README.txt in splitscreenme-nucleus into the docs

This file should be markdown for better readability, and the name should also be change to something more appropriate.

Open Hub in same tab instead of new one

When you click on "Game's Hub", it opens the hub.splitscreen.me in a new tab. It would be better if it got opened in the same tab.

Merge dependabot PRs

Add more GOG emulator documentation

I have searched through the issues and didn't find my problem.

• Confirm

Documentation description

Nemirtinga's Galaxy Emulator works by substituting the game's Galaxy64.dll file with its own custom dll.

First, set up Nemirtinga's Galaxy Emulator in Nucleus.

Game.UseNemirtingasGalaxyEmu = true; //Set to true to emulate GOG Galaxy

It is recommended that the emulator is used on the game without Nucleus once before scripting. This can be done by the following steps:

1. Head to the root folder of NucleusCoop
2. Open the utils folder and then open the NemirtingasGalaxyEmu folder. Copy the Galaxy64.dll file.
3. Head to the installation folder of the game you wish to emulate.
4. Find where Galaxy64.dll is stored. This shall be called the Galaxy folder.
5. Rename Galaxy64.dll or move it from the Galaxy folder and paste the Galaxy64.dll from the NemirtingasGalaxyEmu folder.
6. Locate and load the game's executable.

This should generate a folder called ngalaxye_settings. This folder contains a .json file that keeps track of vital information. Keep track of where this folder is located as you will need it for the Nucleus script.

7. If the game loads fine and the game does not crash when trying to use multiplayer, then the emulator is working. Feel free to remove the ngalaxye_settings folder and Galaxy64.dll, and restore the original Galaxy64.dll file to the Galaxy folder.

With the steps above done, write inside the Game.Play() function:

var idg = Context.PlayerID + 6;
var jsonPath = Context.GetFolder(Nucleus.Folder.InstancedGameFolder) + "\\ngalaxye_settings\\NemirtingasGalaxyEmu.json"; //The string should be changed so that ngalaxye_settings is in the same folder as it was in Step 6.
var params = [
'{',
'  "api_version": "1.139.2.0",', //Must be changed or the game cannot connect to LAN. API version can be found by right-clicking the original Galaxy64.dll, clicking the 'Details' tab and reading the File Version tag.
'  "enable_overlay": false,', //Can be left unchanged
'  "galaxyid": 14549624462898294'+idg+',', //Can be left unchanged
'  "language": ' + '"' + Context.GogLang + '",', //Can be left unchanged
'  "productid": 2143654691,', //Must be changed or the game will crash. Product ID can be found by visitng https://www.gogdb.org/
'  "username": ' + '"' + Context.Nickname + '"', //Must always be added and must be the last line or else the emulator will reset all parameters (there is no comma at the end of this line in the json).
'}'
];

Context.WriteTextFile(jsonPath,params);

Common Errors:
Q. The game's multiplayer only works when GOG Galaxy is open and even then, I can only play with my friends on GOG Galaxy.
A. Make sure you set Game.UseNemirtingasGalaxyEmu = true

Q. The game crashes upon entering the multiplayer gamemode or main menu.
A. The game is either not loading the custom Galaxy64.dll file or not loading the .json file correctly. Make sure you set Game.UseNemirtingasGalaxyEmu = true, make sure that the ngalaxye_settings folder is in the correct place and make sure the .json file has the correct parameters (i.e. make sure productid and api_version is correct).

Q. The game loads fine but I cannot connect to other players in Nucleus.
A. The api_version has been set incorrectly. Go to the game's installation folder, locate the Galaxy64.dll, click the 'Details' tab and read the File Version. That is what your api_version should be.

Why do we need this documentation?

To help people when it comes to emulating GOG Galaxy for games bought from GOG

Additional information

No response

📇 No license in various repositories

I have searched through the issues and didn't find my problem.

• Confirm

Feature description

The license is missing in the repository. Having a license is something every project must have, IMO.
You might want to check all the other unlicensed repositories as well.

Why do we need this feature?

With a license, people will know what they can and can NOT do with the code.
This also protects you and the project itself (see more in the link below).

Additional information

https://www.freecodecamp.org/news/how-open-source-licenses-work-and-how-to-add-them-to-your-projects-34310c3cf94/

Add issue forms

Pretty much exactly what we have already added to the Splitscreenme-nucleus repo in this PR, but with different forms such as update documentation, new documentation, feature request, bug report

Documentation: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms

Example of usage: https://github.com/SplitScreen-Me/splitscreenme-nucleus/issues/new/choose

📝 Update FAQ

The FAQ is missing some stuff:

• How to add mods (for steam games)
• Launching nucleus as admin when a game doesn't work
• Checking if steam is running in the background (some games require it, others require it to be closed)
• Disabling overlays (Discord, Steam, etc...) fixes some issues
• I wish to help out with the project should also link to GitHub, and let them know they can contribute there

Will update this list if I find any more :)