Skip to content

Commit

Permalink
Project rename corrections
Browse files Browse the repository at this point in the history
  • Loading branch information
@LeonardoTheMutant
LeonardoTheMutant committed Oct 26, 2024
1 parent 2269d79 commit 5f67f51
Show file tree
Hide file tree
Showing 9 changed files with 153 additions and 99 deletions.
87 changes: 56 additions & 31 deletions README.MD
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
# LeonardoTheMutant's Murder Mystery
**(Formely "SRB2 Murder Mystery")**

Murder Mystery gametype add-on for [Sonic Robo Blast 2](https://www.srb2.org)
A port of the popular multiplayer game in a form of a new gametype for [Sonic Robo Blast 2](https://www.srb2.org)

A port of the popular multiplayer game in SRB2

***Not to be confused with the [Saxashitter's Murder Mystery](https://github.com/Saxashitter/murder-mystery) project, which also tries to port MM to SRB2 but is an entirely different project***
***Not to be confused with the [Saxashitter's Murder Mystery](https://github.com/Saxashitter/murder-mystery), which is an entirely different MM project for SRB2***

<a href="https://github.com/LeonardoTheMutant/SRB2-Murder-Mystery/graphs/contributors" alt="Contributors">
<img src="https://img.shields.io/github/contributors/LeonardoTheMutant/SRB2-Murder-Mystery"></a>
Expand All @@ -16,52 +14,79 @@ A port of the popular multiplayer game in SRB2
<a href="https://discord.gg/UgG8h2djFE">
<img src="https://img.shields.io/discord/1075825170658381926?logo=discord" alt="chat on Discord"></a>

## How to build your **LTMs_MurderMystery.PK3** from this repository
## Overview
*(There is supposed to be a short explanation of the game with some gameplay screenshots, feel free to contribute to this section)*

## How to build a **.PK3** file out of this repository

**Please note that MAKE scripts generate the Debug (Test) versions of the Add-On and it is highly recomended to HOST THESE BUILDS ONLY ON PRIVATE SERVERS.**
Release versions of the Add-On, which are tested and approved to be showcased publicly, are available in **Releases**
**Please note that MAKE scripts generate the *Debug* (*Test*) versions of the Add-On and it is highly recomended to HOST THESE BUILDS ONLY ON PRIVATE SERVERS.**
Release versions of the Add-On, which are tested and approved to be showcased publicly, are available in [Releases](https://github.com/LeonardoTheMutant/SRB2-Murder-Mystery/releases)

### If you have `git` installed

1. Open your *Terminal* (*Command Prompt* in Windows)
2. Clone this repository with `git clone https://github.com/LeonardoTheMutant/SRB2-Murder-Mystery` command
3. Go to the folder of the cloned repository (`cd SRB2-MurderMystery`)
4. Launch one of the `MAKE` scripts ([MAKE.BAT](MAKE.BAT) for Windows or [MAKE.SH](MAKE.SH) for macOS/Linux) to generate the **Debug version** of the Add-On

### In case you don't have `git`
2. Clone this repository
```sh
git clone https://github.com/LeonardoTheMutant/SRB2-Murder-Mystery
```
3. Go to the folder of the cloned repository
```sh
cd SRB2-MurderMystery
```
4. Launch one of the `MAKE` scripts that will generate the `.pk3` file with the **Debug version** of the Add-On:
- Windows:
```batch
MAKE.BAT
```
- Linux/macOS:
```sh
./MAKE.SH
```

### In case you don't have `git` installed

1. Download the contents of this repository as a .ZIP archive
2. Unarchive the downloaded .ZIP wherever you want on your machine
3. Go to the unarchived folder and run one of the `MAKE` ([MAKE.BAT](MAKE.BAT) for Windows or [MAKE.SH](MAKE.SH) for macOS/Linux) scripts to generate the **Debug version** of the SRB2-MM Add-On
3. Go to the unarchived folder and run one of the `MAKE` ([MAKE.BAT](MAKE.BAT) for Windows or [MAKE.SH](MAKE.SH) for macOS/Linux) scripts to generate the **Debug version** of the Add-On
4. *(Optional) Find and install the `git` package for your OS so you won't have to download the repository files manually via .ZIP again*
## How to start the server with Murder Mystery Add-On
### From command line

1. Add the `-server` parameter to your prompt to make SRB2 start as Listen Server or `-dedicated` to start a dedicated server instead;
2. Add `-file` parameter with a path to the add-on file you wanna use like this:`-file [path_to_the_addon]`;
3. Use `-gametype` parameter to specify the gametype you want to start server with. In case of Murder Mystery it must be `-gametype "Murder Mystery"`;
4. You probably don't want to start from Greenflower 1 so don't forget to add `-warp` to start the game from the specified level. To start from "Abandoned Shelter" map use `-warp MAPK0`

This is what your SRB2 launch prompt should look like at the end (I use Windows build here): `srb2win.exe -server (-dedicated) -file [place_where_addon_located]/[MurderMystery-packname].pk3 -gametype "Murder Mystery" -warp MAPK0`
- Add the `-server` parameter to your prompt to make SRB2 start as **Listen Server** (where host is a player) or `-dedicated` to start a **Dedicated Server** (where host is NOT a player and is a dedicated console) instead;
- Add `-file` parameter with the path(s) to the add-on file(s) you want use;
- Use `-gametype` parameter to specify the Type of Level (Gametype) you want your server to start with. In case of Murder Mystery it must be `-gametype LTM_MM`;
- Use `-warp` to start the game from the specified level (otherwise the map will be *Greenflower 1*). To start from the *"Abandoned Shelter"* use `-warp MAPK0`
This is what your SRB2 launch prompt should look like at the end:
- Windows:
```batch
srb2win.exe -server -file [place_where_addon_located]/[MurderMystery].pk3 -gametype LTM_MM -warp MAPK0
```
- macOS:
```sh
open /Applications/Sonic\ Robo\ Blast\ 2.app --args -server -file [place_where_addon_located]/[MurderMystery].pk3 -gametype LTM_MM -warp MAPK0
```
- Linux:
```sh
./lsdlsrb2 -server -file [place_where_addon_located]/[MurderMystery].pk3 -gametype LTM_MM -warp MAPK0
```
Don't forget to replace `[]` brackets with your path and the name of your .PK3 file you are going to use respectively.

### From in-game console

`MAP [MMmapnum] -GAMETYPE LTM_MurderMystery"`

As a `[MMmapnum]` you can use **MAPK0** (Abandoned Shelter)
```
map [mapnum] -gametype LTM_MM
```
As a `[mapnum]` you can use **MAPK0** or **K0** (*"Abandoned Shelter"*)
## Open assets used in this project

- Heavily modified ModernSonic's footsteps engine, [original fork of the script](https://mb.srb2.org/addons/footsteps.1378/) by Gomynola - Used to make footstep sounds and marks when players walk.
- Music & Textures from the [Freedoom](https://github.com/freedoom/freedoom) project.
- MIDI files for the music from [VGMusic](https://vgmusic.com)
## For people who want to contribute to the project
The [Pull Requests](https:gtihub.com/LeonardoTheMutant/SRB2-Murder-Mystery/pulls) are always open! All contributions would be greatly appreciated especially maps, music, graphics, ideas or bug fixes. If you want to make somrthing unique you can even make a translation. Yes you read it right, this gametype supports localisations on different languages. You can add your own language to the project by either
All contributions would be greatly appreciated especially maps, music, graphics, ideas, bug fixes or even translations! Yes you read it right, this gametype supports localisations on different languages. You can add your own language to the project by either

1. Modifying the source code you are having right now
2. Making a **Custom Language File** from the [template](TEMPLATES/customlang.lua) and then adding it as a regular ADD-ON together with MM (Main Add-On has to be loaded first)

### Also check out the [Saxashitter's Murder Mystery](https://github.com/Saxashitter/murder-mystery) project
1. Modifying the source code you are having right now and creating a new Pull Request
2. Making a **Custom Language File** from the [template](TEMPLATES/customlang.lua) and then adding it as a regular ADD-ON together with MM (main Add-On has to be loaded first)
90 changes: 58 additions & 32 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
# SRB2 Murder Mystery
# LeonardoTheMutant's Murder Mystery
**(Formely "SRB2 Murder Mystery")**

Murder Mystery gametype add-on for [Sonic Robo Blast 2](https://www.srb2.org)
A port of the popular multiplayer game in a form of a new gametype for [Sonic Robo Blast 2](https://www.srb2.org)

A port of the popular multiplayer game in SRB2

***Not to be confused with the [Saxashitter's Murder Mystery](https://github.com/Saxashitter/murder-mystery) add-on, which tries to acomplish the same goal but is an entirely different project***
***Not to be confused with the [Saxashitter's Murder Mystery](https://github.com/Saxashitter/murder-mystery), which is an entirely different MM project for SRB2***

<a href="https://github.com/LeonardoTheMutant/SRB2-Murder-Mystery/graphs/contributors" alt="Contributors">
<img src="https://img.shields.io/github/contributors/LeonardoTheMutant/SRB2-Murder-Mystery"></a>
Expand All @@ -15,52 +14,79 @@ A port of the popular multiplayer game in SRB2
<a href="https://discord.gg/UgG8h2djFE">
<img src="https://img.shields.io/discord/1075825170658381926?logo=discord" alt="chat on Discord"></a>

## How to build your **MurderMystery.PK3** from this repository
## Overview
*(There is supposed to be a short explanation of the game with some gameplay screenshots, feel free to contribute to this section)*

## How to build a **.PK3** file out of this repository

**Please note that MAKE scripts generate the Debug (Test) versions of the Add-On and it is highly recomended to HOST THESE BUILDS ONLY ON PRIVATE SERVERS.**
Release versions of the Add-On, which are tested and approved to be showcased publicly, are available in **Releases**
**Please note that MAKE scripts generate the *Debug* (*Test*) versions of the Add-On and it is highly recomended to HOST THESE BUILDS ONLY ON PRIVATE SERVERS.**
Release versions of the Add-On, which are tested and approved to be showcased publicly, are available in [Releases](https://github.com/LeonardoTheMutant/SRB2-Murder-Mystery/releases)

### If you have `git` installed

1. Open your *Terminal* (*Command Prompt* in Windows)
2. Clone this repository with `git clone https://github.com/LeonardoTheMutant/SRB2-Murder-Mystery` command
3. Go to the folder of the cloned repository (`cd SRB2-MurderMystery`)
4. Launch one of the `MAKE` scripts ([MAKE.BAT](MAKE.BAT) for Windows or [MAKE.SH](MAKE.SH) for macOS/Linux) to generate the **Debug version** of the Add-On

### In case you don't have `git`
2. Clone this repository
```sh
git clone https://github.com/LeonardoTheMutant/SRB2-Murder-Mystery
```
3. Go to the folder of the cloned repository
```sh
cd SRB2-MurderMystery
```
4. Launch one of the `MAKE` scripts that will generate the `.pk3` file with the **Debug version** of the Add-On:
- Windows:
```batch
MAKE.BAT
```
- Linux/macOS:
```sh
./MAKE.SH
```

### In case you don't have `git` installed

1. Download the contents of this repository as a .ZIP archive
2. Unarchive the downloaded .ZIP wherever you want on your machine
3. Go to the unarchived folder and run one of the `MAKE` ([MAKE.BAT](MAKE.BAT) for Windows or [MAKE.SH](MAKE.SH) for macOS/Linux) scripts to generate the **Debug version** of the SRB2-MM Add-On
3. Go to the unarchived folder and run one of the `MAKE` ([MAKE.BAT](MAKE.BAT) for Windows or [MAKE.SH](MAKE.SH) for macOS/Linux) scripts to generate the **Debug version** of the Add-On
4. *(Optional) Find and install the `git` package for your OS so you won't have to download the repository files manually via .ZIP again*
## How to start the server with Murder Mystery Add-On
### From command line

1. Add the `-server` parameter to your prompt to make SRB2 start as Listen Server or `-dedicated` to start a dedicated server instead;
2. Add `-file` parameter with a path to the add-on file you wanna use like this:`-file [path_to_the_addon]`;
3. Use `-gametype` parameter to specify the gametype you want to start server with. In case of Murder Mystery it must be `-gametype "Murder Mystery"`;
4. You probably don't want to start from Greenflower 1 so don't forget to add `-warp` to start the game from the specified level. To start from "Abandoned Shelter" map use `-warp MAPK0`

This is what your SRB2 launch prompt should look like at the end (I use Windows build here): `srb2win.exe -server (-dedicated) -file [place_where_addon_located]/[MurderMystery-packname].pk3 -gametype "Murder Mystery" -warp MAPK0`
- Add the `-server` parameter to your prompt to make SRB2 start as **Listen Server** (where host is a player) or `-dedicated` to start a **Dedicated Server** (where host is NOT a player and is a dedicated console) instead;
- Add `-file` parameter with the path(s) to the add-on file(s) you want use;
- Use `-gametype` parameter to specify the Type of Level (Gametype) you want your server to start with. In case of Murder Mystery it must be `-gametype LTM_MM`;
- Use `-warp` to start the game from the specified level (otherwise the map will be *Greenflower 1*). To start from the *"Abandoned Shelter"* use `-warp MAPK0`
This is what your SRB2 launch prompt should look like at the end:
- Windows:
```batch
srb2win.exe -server -file [place_where_addon_located]/[MurderMystery].pk3 -gametype LTM_MM -warp MAPK0
```
- macOS:
```sh
open /Applications/Sonic\ Robo\ Blast\ 2.app --args -server -file [place_where_addon_located]/[MurderMystery].pk3 -gametype LTM_MM -warp MAPK0
```
- Linux:
```sh
./lsdlsrb2 -server -file [place_where_addon_located]/[MurderMystery].pk3 -gametype LTM_MM -warp MAPK0
```
Don't forget to replace `[]` brackets with your path and the name of your .PK3 file you are going to use respectively.

### From in-game console

`MAP [MMmapnum] -GAMETYPE "Murder Mystery"`

Brackets are important in `"Murder Mystery"`! As a `[MMmapnum]` you can use **MAPK0** (Abandoned Shelter)
```
map [mapnum] -gametype LTM_MM
```
As a `[mapnum]` you can use **MAPK0** or **K0** (*"Abandoned Shelter"*)
## Open assets used in this project

- Heavily modified ModernSonic's footsteps engine, [original fork of the script](https://mb.srb2.org/addons/footsteps.1378/) by Gomynola - Used to make footstep sounds and marks when players walk.
- Music & Textures from the [Freedoom](https://github.com/freedoom/freedoom) project.
- MIDI files for the music from [VGMusic](https://vgmusic.com)
## For people who want to contribute to the project
The [Pull Requests](https:gtihub.com/LeonardoTheMutant/SRB2-Murder-Mystery/pulls) are always open! All contributions would be greatly appreciated especially maps, music, graphics, ideas or bug fixes. If you want to make somrthing unique you can even make a translation. Yes you read it right, this gametype supports localisations on different languages. You can add your own language to the project by either
All contributions would be greatly appreciated especially maps, music, graphics, ideas, bug fixes or even translations! Yes you read it right, this gametype supports localisations on different languages. You can add your own language to the project by either

1. Modifying the source code you are having right now
2. Making a **Custom Language File** from the [template](TEMPLATES/customlang.lua) and then adding it as a regular ADD-ON together with MM (Main Add-On has to be loaded first)

### Also check out the [Saxashitter's Murder Mystery](https://github.com/Saxashitter/murder-mystery) project
1. Modifying the source code you are having right now and creating a new Pull Request
2. Making a **Custom Language File** from the [template](TEMPLATES/customlang.lua) and then adding it as a regular ADD-ON together with MM (main Add-On has to be loaded first)
8 changes: 4 additions & 4 deletions SRC/INIT.LUA
View file
Original file line number Diff line number Diff line change
Expand Up @@ -161,18 +161,18 @@ CV_RegisterVar({name = "mm_autofire", defaultvalue = "On", PossibleValue = CV_On
print("\n\x87LTM's MURDER MYSTERY \x81v"..MM.version.."\n")

--Freeslot Gametype, Sheriff's Emerald & Knife object
freeslot('TOL_MURDERMYSTERY', 'MT_SHREML', 'MT_MMKNIFE', 'SPR_STEPA0', 'S_MMSTEP', 'MT_MMSTEP')
freeslot('TOL_LTM_MM', 'MT_SHREML', 'MT_MMKNIFE', 'SPR_STEPA0', 'S_MMSTEP', 'MT_MMSTEP')
freeslot('sfx_mmdth1', 'sfx_mmdth2', 'sfx_mmdth3', 'sfx_mmdth4', 'sfx_mmdth5', 'sfx_mmdth6', 'sfx_mmdth7')

G_AddGametype({
name = "LTM_MurderMystery",
name = "LTM_MM",
identifier = "ltmmurdermystery",
typeoflevel = TOL_MURDERMYSTERY,
typeoflevel = TOL_LTM_MM,
rules = GTR_DEATHMATCHSTARTS|GTR_RINGSLINGER|GTR_FIRSTPERSON|GTR_TIMELIMIT,
intermissiontype = int_match,
headerleftcolor = 37,
headerrightcolor = 153,
description = "Kill everyone as Murderer, prevent the murders as Sheriff and survive as Innocent!"
description = "\x88LeonardoTheMutant's\x80 \x87Murder Mystery\x80:\nKill everyone as \x85Murderer\x80, prevent the murders as \x84Sheriff\x80 and survive as \x83Innocent\x80!"
})

--Sheriff Drop Emerald
Expand Down
6 changes: 3 additions & 3 deletions SRC/NOTES4HOSTERS.TXT
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ for those who are going to host this addon pack on their server (including you)
A. From the command line:
1) Add the game-type addon file with "-FILE [path_to_the_addon]" parameter;
2) Write the name of the gametype to launch like:
-gametype LTM_MurderMystery
-gametype LTM_MM
3) You probably don't want to start from Greenflower1 so you need to use "-WARP MAPK0"
to start from MM maps.

The final command line should be something like:
srb2win.exe -server (-dedicated) -file [place_where_addon_located]/MM_MurderMystery-v[ver].pk3 -gametype "Murder Mystery" -warp MAPK0
srb2win.exe -server (-dedicated) -file [place_where_addon_located]/MM_MurderMystery-v[ver].pk3 -gametype LTM_MM -warp MAPK0

B. From the in-game console:
MAP [MMmapnum] -GAMETYPE LTM_MurderMystery
MAP [MMmapnum] -GAMETYPE LTM_MM

---=== Admin-only MM commands/variables ===---
There are a couple of Commands and Console Variables available for admins to use. Here are all of them:
Expand Down
14 changes: 8 additions & 6 deletions SRC/README.TXT
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,12 @@
I hope you enjoyed the mod!"

ADD-ON TECHNICAL INFORMATION
------------------+----------------------------------------------------------------------------
Add-On name | LeonardoTheMutant's Murder Mystery (formely "SRB2 Murder Mystery")
------------------+------------------------------------------------------
Add-On name | LeonardoTheMutant's Murder Mystery
| (formely "SRB2 Murder Mystery")
|
Add-On version | 1.0-ALPHA
Add-On type | New game type
Add-On type | New gametype
REUSABLE | Yes
|
Modifies vanilla |
Expand All @@ -24,7 +26,7 @@ New music | Yes (MIDI only***)
|
Included |
translations | English, Polish, Russian, Turkish, Ukrainian
------------------+----------------------------------------------------------------------------
------------------+------------------------------------------------------
* The add-on was designed to not modify the vanilla aspects of the game.
There is only one known bug where Metal Sonic can't get into his Hyper Dash
mode when playing in vanilla game types with MM add-on present
Expand All @@ -33,9 +35,9 @@ translations | English, Polish, Russian, Turkish, Ukrainian



=================================================
============================================================
"LeonardoTheMutant's Murder Mystery" is made by SRB2MM_DEV
=================================================
============================================================

SRB2MM_DEV team is:
LeonardoTheMutant - "CEO of the project", Mapper, Coder, Visual Design, Ukrainian, Russian & Polish translator
Expand Down
Loading

0 comments on commit 5f67f51

Please sign in to comment.