Skip to content

Latest commit

 

History

History
110 lines (73 loc) · 6 KB

README.md

File metadata and controls

110 lines (73 loc) · 6 KB
Raw

SFDScripts

Project Build, Test & Deploy

My Superfighters Deluxe Scripts

This is a collection of the scripts I use when hosting, most of the time I take existing maps along with their scripts, then I modify them to "enhace" them: upgrade the performances, refactor them, make them more readable, remove useless code, change the naming of classes and variables, etc...

As for scripts I have made "myself":

  • "MarioPanadero.cs" which is largely inspired on the Battle Of Teams script used by Nets in most of his maps.
  • Hardcore script modifications and updates, which are here thanks to @Antonikon

This repo is here solely as a collection of modified scripts. I, in no case, declare the author of all of the code that this repo contains.

REPO STRUCTURE

•
├── Backup (a backup of a collection of maps a used 3 years ago on the server I hosted)
│
├── SFDScripts (folder containing the actual scripts project)
│   │
│   ├── EXTERNAL (fodler containing external scripts: scripts that you can activate on any map, not map dependant)
│   │
│   ├── INTERNAL (folder containing internal scripts: scripts that are map dependant, and need to be the script inside the map they're supposed to use)
│   │
│   └── TESTS (some tests I have made, not too many ^^)
│
├── docs (folder containing a backup of the script documentation, also used for a webhook available here: https://juansero29.github.io/SFDScripts/)
│
├── LICENSE (the LGPL-2.1 License for this repo)
│
└── SFDScripts.sln (the Visual Studio 2019 solution)

PROJECTS

I'm currently working on two main projects on SFD:

  1. Making all battle of teams map bot-enabled (available to be played with bots)
  2. Restoring Antonikon's Hardcore server using his open-sourced script and remastering his maps.

You can follow these projects in here: https://github.com/Juansero29/SFDScripts/projects

CONTRIBUTING

You're free to make comments, create issues and PRs! I'm open to suggestions.

Check CONTRIBUTING.MD for very detailed information on how to start contributing.

CLONING, COMPILING, AND PUSHING TO REPOSITORY

Pre-requisites

For cloning and working with this repo, you will ned Git LSF, since I use Github LSF storage to store \*.sfdm files. As a pre-requisite you will need to:

  1. Install Chocolatey - Link
  2. Install latest version of Git LSF - Run command choco upgrade git-lfs.install on Powershell after installing Chocolatey

If you get an error message of "choco" not being recognized, close the Powershell instance, and open a new one with admin rights, then run the command again

If you get error messages when changing branches, creating branches or pushing, it is probably tied to a particular Git LSF version. Please re run choco upgrade git-lfs.install even if you had already installed Git LSF in the past

CLONING THE REPO

  1. git clone https://github.com/Juansero29/SFDScripts.git
  2. git lfs fetch --all

EDITING AND BUILDING CODE

Thanks to @NotRustyBot, Hardcore and maybe other projects from this repo can be split into separated files to be easily edited and understood, and then will be merged into one by using a console utilitary done by @NotRustyBot

It also allows to send the map into the Superfighters Deluxe program directly, avoiding to boilerplate process of copy/pasting the code into the Script Editor in SFD.

The utilitary that @NotRustyBot created that made this possible is also in this repository over SFDScripts\Utilities\SfdScriptUtil

BUILD HARDCORE WITH SFD MAP EDITOR OPEN

  1. Edit the source code files inside SFDScripts\SFDScripts\Internal\Hardcore\Source
  2. Make sure Superfighters Deluxe Map Editor is open, and that the map you want to test is open too.
  3. Open the terminal, be sure to be at the root of the repo
  4. In the terminal, launch .\ScriptUtil.exe -i SFDScripts\Internal\Hardcore\X.cs -d true, where X is the name of the CSharp file of the map you want to launch.
  5. All of the modifications inside the Source folder will be sent to the SFDScripts\SFDScripts\Internal\Hardcore\Hardcore.cs file, and the map dependant date will be taken from the X map you precised.
  6. The map should start running with the updated code.

BUILD WITH SFD MAP EDITOR CLOSED

  1. Edit the source code files inside SFDScripts\SFDScripts\Internal\Hardcore\Source
  2. Open the terminal, be sure to be at the root of the repo
  3. In the terminal, launch .\ScriptUtil.exe -i SFDScripts\Internal\Hardcore\X.cs -d false, where X is the name of the CSharp file of the map you want to launch.
  4. All of the modifications inside the Source folder will be sent to the SFDScripts\SFDScripts\Internal\Hardcore\Hardcore.cs file, and the map dependant date will be taken from the X map you precised.

PUSH COMMANDS

  1. git add --renormalize .
  2. git lfs fetch --all origin your-branch-name
  3. git lfs push --all origin your-branch-name
  4. git commit -m "commit message"
  5. git push

OTHER USEFUL COMMANDS

  • git reset --soft head~ - undo latest commit

LICENSE

This repository is licensed under the GNU Lesser General Public License v2.1. Primarily used for software libraries, the GNU LGPL requires that derived works be licensed under the same license, but works that only link to it do not fall under this restriction. There are two commonly used versions of the GNU LGPL.

TRADEMARK NOTICE

Superfighters Deluxe® logos, their taglines and the look, feel and trade dress of the Service are the exclusive trademarks, service marks, trade dress and logos of MythoLogic Interactive®. All other trademarks, service marks, trade dress, and logos used on this repository are the trademarks, service marks, trade dress, and logos of their respective owners.