Skip to content

Commit a8dcb49

Browse files
committed
fix: rename projects
1 parent c76d6b8 commit a8dcb49

File tree

25 files changed

+128
-128
lines changed

25 files changed

+128
-128
lines changed

content/1.introduction/5.faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ To get started with Plugify:
2323

2424
1. **For Users**:
2525
- Download and install Plugify from the [GitHub repository](https://github.com/untrustedmodders/plugify).
26-
- Explore standalone implementations like [S2-Plugify](https://github.com/untrustedmodders/s2-plugify) or [MM2-Plugify](https://github.com/untrustedmodders/mms2-plugify) to see Plugify in action.
26+
- Explore standalone implementations like [S2-Launcher](https://github.com/untrustedmodders/plugify-source2-launcher) or [MM2-Plugify](https://github.com/untrustedmodders/plugify-metamod-loader) to see Plugify in action.
2727

2828
2. **For Developers**:
2929
- Clone the repository:

content/2.essentials/1.installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ icon: lucide:download
66

77
## Implementations
88

9-
If you’re using Plugify for game modding (e.g., Counter-Strike 2), you’ll need to install **S2-Plugify** or **MMS2-Plugify**. These projects provide pre-configured setups for specific games.
9+
If you’re using Plugify for game modding (e.g., Counter-Strike 2), you’ll need to install **S2-Launcher** or **MM-Loader**. These projects provide pre-configured setups for specific games.
1010

1111
::card-group
1212
::card

content/2.essentials/6.commands.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ icon: lucide:terminal
77
Plugify provides a powerful Command Line Interface (CLI) for managing plugins, language modules, and packages. Below is a comprehensive list of available commands, organized by functionality.
88

99
## **Important Note**
10-
The commands listed here are **not part of the Plugify core itself**. Instead, they are implemented manually by each project that integrates Plugify. This is because different projects may have unique input systems, CLI frameworks, or user interaction requirements. The examples provided in this documentation are based on the implementations used in **MM2-Plugify** and **S2-Plugify**, which are specific to those projects. Your implementation may vary depending on your project's needs.
10+
The commands listed here are **not part of the Plugify core itself**. Instead, they are implemented manually by each project that integrates Plugify. This is because different projects may have unique input systems, CLI frameworks, or user interaction requirements. The examples provided in this documentation are based on the implementations used in **MM2-Plugify** and **S2-Launcher**, which are specific to those projects. Your implementation may vary depending on your project's needs.
1111

1212
## **Plugin Manager Commands**
1313

content/3.use-cases/0.integrations.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Launch **Counter-Strike 2** or **Deadlock** with Plugify injected, allowing you
3232

3333
### Comparisons
3434

35-
| Feature | MMS2-Plugify (MetaMod Integration) | S2-Plugify (Standalone Launcher) |
35+
| Feature | MM-Loader (MetaMod Integration) | S2-Launcher (Standalone Launcher) |
3636
|-----------------|-----------------------------------------------|--------------------------------------|
3737
| **Dependency** | Requires MetaMod | No external dependencies |
3838
| **Use Case** | Server-side modding, community-driven plugins | Standalone modding, custom launchers |
@@ -42,12 +42,12 @@ Launch **Counter-Strike 2** or **Deadlock** with Plugify injected, allowing you
4242

4343
### Choosing the Right Implementation
4444

45-
- **Choose MMS2-Plugify if**:
45+
- **Choose MM-Loader if**:
4646
- You are working with Source 2 games like *CS2* or *Deadlock*.
4747
- You want to leverage MetaMod's existing infrastructure.
4848
- You need server-side modding capabilities or community-driven plugin support.
4949

50-
- **Choose S2-Plugify if**:
50+
- **Choose S2-Launcher if**:
5151
- You prefer a standalone solution without dependencies.
5252
- You are developing custom game launchers or testing plugins.
5353
- You want full control over plugin loading and game execution.

content/3.use-cases/1.metamod-plugin/1.overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Learn how to integrate Plugify as a Metamod plugin for Source 2 gam
44
icon: lucide:gamepad
55
---
66

7-
**MMS2-Plugify** integrates Plugify as a MetaMod plugin for Source 2. This implementation enables extended modding capabilities by leveraging MetaMod's existing infrastructure while adding Plugify's powerful plugin and language module system.
7+
**MM-Loader** integrates Plugify as a MetaMod plugin for Source 2. This implementation enables extended modding capabilities by leveraging MetaMod's existing infrastructure while adding Plugify's powerful plugin and language module system.
88

99
### Key Features
1010
- **MetaMod Integration**: Works seamlessly with MetaMod, a trusted and widely-used modding framework for Source 2 games.
@@ -17,7 +17,7 @@ icon: lucide:gamepad
1717
- **High-Performance Scripting**: Leverage Plugify's C++ language module for performance-critical plugins.
1818

1919
### Example
20-
A server administrator for *CS2* can use MMS2-Plugify to load a custom plugin that adds new game modes, such as a zombie survival mode, while leveraging Plugify's C++ language module for high-performance scripting.
20+
A server administrator for *CS2* can use MM-Loader to load a custom plugin that adds new game modes, such as a zombie survival mode, while leveraging Plugify's C++ language module for high-performance scripting.
2121

2222
### Benefits
2323
- **Seamless Integration**: Works alongside MetaMod, reducing setup complexity.

content/3.use-cases/1.metamod-plugin/2.installation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Step-by-step guide to installing Plugify as a Metamod plugin for So
44
icon: lucide:download
55
---
66

7-
This guide will walk you through the installation process for **MMS2-Plugify** on your server. Plugify requires **Metamod** to be installed as a loader on the server. Follow the steps below to get everything set up.
7+
This guide will walk you through the installation process for **MM-Loader** on your server. Plugify requires **Metamod** to be installed as a loader on the server. Follow the steps below to get everything set up.
88

99
## Prerequisites
1010

@@ -18,8 +18,8 @@ This guide will walk you through the installation process for **MMS2-Plugify** o
1818

1919
::steps
2020
### **Download Plugify**
21-
Download the latest version of **MMS2-Plugify** from our download page:
22-
[MMS2-Plugify Download](https://github.com/untrustedmodders/mms2-plugify).
21+
Download the latest version of **MM-Loader** from our download page:
22+
[MM-Loader Download](https://github.com/untrustedmodders/plugify-metamod-loader).
2323

2424
### **Extract Plugify**
2525
Extract the downloaded archive into your server’s game folder. For example, if your server’s game folder is located at `../my_server/game/csgo`, extract the files there.

content/3.use-cases/1.metamod-plugin/3.building.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,24 @@ description: Instructions for compiling Plugify from source to customize it for
44
icon: lucide:blocks
55
---
66

7-
This guide provides instructions for building **MMS2-Plugify**, a specialized version of Plugify designed for Counter-Strike 2 servers. The build process is nearly identical to building the core Plugify library, with one key difference: the target name should be `mms2-plugify` instead of `plugify`.
7+
This guide provides instructions for building **MM-Loader**, a specialized version of Plugify designed for Counter-Strike 2 servers. The build process is nearly identical to building the core Plugify library, with one key difference: the target name should be `plugify-metamod-loader` instead of `plugify`.
88

99
## **Key Difference**
10-
When building **MMS2-Plugify**, ensure that you specify the target name as `mms2-plugify` instead of `plugify`. For example:
10+
When building **MM-Loader**, ensure that you specify the target name as `plugify-metamod-loader` instead of `plugify`. For example:
1111

1212
```bash
13-
cmake --build . --target mms2-plugify
13+
cmake --build . --target plugify-metamod-loader
1414
```
1515

16-
## **Steps to Build MMS2-Plugify**
16+
## **Steps to Build MM-Loader**
1717

1818
::steps
1919
### **Clone the Repository**
20-
Clone the **MMS2-Plugify** repository to your local machine:
20+
Clone the **MM-Loader** repository to your local machine:
2121

2222
```bash
23-
git clone https://github.com/untrustedmodders/mms2-plugify.git --recursive
24-
cd mms2-plugify
23+
git clone https://github.com/untrustedmodders/plugify-metamod-loader.git --recursive
24+
cd plugify-metamod-loader
2525
```
2626

2727
### **Generate Build Files**
@@ -34,10 +34,10 @@ cmake ..
3434
```
3535

3636
### **Build the Project**
37-
Build the project using the following command. **Note**: The target name is `mms2-plugify`.
37+
Build the project using the following command. **Note**: The target name is `plugify-metamod-loader`.
3838

3939
```bash
40-
cmake --build . --target mms2-plugify
40+
cmake --build . --target plugify-metamod-loader
4141
```
4242

4343
### **Verify the Build**
@@ -47,7 +47,7 @@ Once the build process is complete, the compiled files will be located in the `b
4747
::
4848

4949
## **Detailed Build Instructions**
50-
For more detailed instructions on building Plugify (e.g., configuring CMake options, enabling tests, or building documentation), refer to the [Building Plugify](/essentials/building) guide. The process is identical, except for the target name (`mms2-plugify` instead of `plugify`).
50+
For more detailed instructions on building Plugify (e.g., configuring CMake options, enabling tests, or building documentation), refer to the [Building Plugify](/essentials/building) guide. The process is identical, except for the target name (`plugify-metamod-loader` instead of `plugify`).
5151

5252
:read-more{icon="lucide:link" to="/essentials/building"}
5353

@@ -59,7 +59,7 @@ For more detailed instructions on building Plugify (e.g., configuring CMake opti
5959
- Verify that all dependencies are available and properly configured.
6060

6161
2. **Target Not Found**:
62-
- Double-check that you are using the correct target name (`mms2-plugify`).
62+
- Double-check that you are using the correct target name (`plugify-metamod-loader`).
6363

6464
3. **Missing Files**:
6565
- Ensure that the repository was cloned correctly and that all files are present.

content/3.use-cases/1.metamod-plugin/4.updating.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,20 @@ description: Learn how to keep Plugify updated and ensure smooth maintenance whe
44
icon: lucide:refresh-cw
55
---
66

7-
Keeping your **MMS2-Plugify** installation up to date is essential for accessing the latest features, bug fixes, and security improvements. This guide will walk you through the manual and automatic update processes.
7+
Keeping your **MM-Loader** installation up to date is essential for accessing the latest features, bug fixes, and security improvements. This guide will walk you through the manual and automatic update processes.
88

99
## **Manual Update**
1010

11-
Since **MMS2-Plugify** is a Metamod plugin, it must be updated manually. Follow these steps to update your installation:
11+
Since **MM-Loader** is a Metamod plugin, it must be updated manually. Follow these steps to update your installation:
1212

1313
::steps
1414
### **Delete the Old Files**
1515
1. Navigate to your server’s game folder (e.g., `../my_server/game/csgo`).
1616
2. Delete the entire `../addons/plugify/bin/` directory. This ensures that no outdated files remain.
1717

1818
### **Install the New Version**
19-
1. Download the latest version of **MMS2-Plugify** from our download page:
20-
[MMS2-Plugify Download](https://github.com/untrustedmodders/mms2-plugify).
19+
1. Download the latest version of **MM-Loader** from our download page:
20+
[MM-Loader Download](https://github.com/untrustedmodders/plugify-metamod-loader).
2121
2. Extract the new files into your server’s game folder, following the [installation tutorial](/use-cases/metamod-plugin/installation/).
2222

2323
:read-more{icon="lucide:link" to="/use-cases/standalone-launcher/installation"}

content/3.use-cases/2.standalone-launcher/1.overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Plugify can run as a standalone game launcher, executing the game d
44
icon: lucide:gamepad
55
---
66

7-
**S2-Plugify** allows Plugify to run as a standalone game launcher, executing the game directly while loading custom plugins. This implementation does not rely on MetaMod, making it ideal for scenarios where a lightweight, independent solution is preferred.
7+
**S2-Launcher** allows Plugify to run as a standalone game launcher, executing the game directly while loading custom plugins. This implementation does not rely on MetaMod, making it ideal for scenarios where a lightweight, independent solution is preferred.
88

99
### Key Features
1010
- **Standalone Execution**: No dependency on MetaMod or other external frameworks.
@@ -17,7 +17,7 @@ icon: lucide:gamepad
1717
- **Rapid Prototyping**: Quickly test and iterate on plugins during development.
1818

1919
### Example
20-
A developer creating a custom mod for *Deadlock* can use S2-Plugify to launch the game with their plugin loaded, allowing them to test new features or gameplay mechanics without needing to integrate with MetaMod.
20+
A developer creating a custom mod for *Deadlock* can use S2-Launcher to launch the game with their plugin loaded, allowing them to test new features or gameplay mechanics without needing to integrate with MetaMod.
2121

2222
### Benefits
2323
- **Lightweight**: No external dependencies, reducing complexity and potential conflicts.

content/3.use-cases/2.standalone-launcher/2.installation.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,20 @@ description: Learn how to install and configure Plugify as a standalone launcher
44
icon: lucide:download
55
---
66

7-
This guide will walk you through the installation process for **S2-Launcher**, a standalone launcher for **S2-Plugify**. Unlike MMS2-Plugify, S2-Launcher does not require Metamod and is designed to run the game while injecting Plugify directly. Follow the steps below to get everything set up.
7+
This guide will walk you through the installation process for **S2-Launcher**, a standalone launcher for **S2-Launcher**. Unlike MM-Loader, S2-Launcher does not require Metamod and is designed to run the game while injecting Plugify directly. Follow the steps below to get everything set up.
88

99
## Prerequisites
1010

1111
::steps
12-
### **Download S2-Plugify**
13-
Download the latest version of **S2-Plugify** from our download page:
14-
[S2-Plugify Download](https://github.com/untrustedmodders/s2-plugify).
12+
### **Download S2-Launcher**
13+
Download the latest version of **S2-Launcher** from our download page:
14+
[S2-Launcher Download](https://github.com/untrustedmodders/plugify-source2-launcher).
1515
::
1616

1717
## Installation Steps
1818

1919
::steps
20-
### **Extract S2-Plugify**
20+
### **Extract S2-Launcher**
2121
Extract the downloaded archive into your game’s installation folder. For example, if your game is installed at `../Counter-Strike Global Offensive`, extract the files there.
2222

2323
After extraction, your folder structure should look like this:
@@ -30,10 +30,10 @@ tree:
3030
- bin:
3131
- win64:
3232
- cs2.exe
33-
- ^s2-plugify.exe^
33+
- ^s2launcher.exe^
3434
- linuxsteamrt64:
3535
- cs2
36-
- ^s2-plugify^
36+
- ^s2launcher^
3737
- core:
3838
- csgo:
3939
- addons:
@@ -48,15 +48,15 @@ tree:
4848
::
4949

5050
### **Use S2-Launcher**
51-
Instead of running the game’s main executable (`cs2.exe` or `cs2`), use the **S2-Launcher** (`s2-plugify.exe` or `s2-plugify`) to start the game. The launcher will automatically inject Plugify into the game process.
51+
Instead of running the game’s main executable (`cs2.exe` or `cs2`), use the **S2-Launcher** (`s2launcher.exe` or `s2launcher`) to start the game. The launcher will automatically inject Plugify into the game process.
5252

5353
#### On Windows:
5454
1. Navigate to the `bin/win64` folder.
55-
2. Run `s2-plugify.exe` instead of `cs2.exe`.
55+
2. Run `s2launcher.exe` instead of `cs2.exe`.
5656

5757
#### On Linux:
5858
1. Navigate to the `bin/linuxsteamrt64` folder.
59-
2. Run `./s2-plugify` instead of `./cs2`.
59+
2. Run `./s2launcher` instead of `./cs2`.
6060

6161
### **Validate the Installation**
6262
To ensure that Plugify has been installed correctly, open the in-game console and type the following command:
@@ -76,7 +76,7 @@ This will display the current version of Plugify running in your game.
7676

7777
### **Common Issues**
7878
1. **Game Fails to Start**:
79-
- Ensure that `s2-plugify.exe` (or `s2-plugify` on Linux) is located in the same folder as the game’s main executable.
79+
- Ensure that `s2launcher.exe` (or `s2launcher` on Linux) is located in the same folder as the game’s main executable.
8080
- Verify that you have the correct permissions to run the launcher.
8181

8282
2. **Plugify Commands Not Working**:
@@ -88,8 +88,8 @@ This will display the current version of Plugify running in your game.
8888

8989

9090
4. **Dedicated Server Not Starting**:
91-
- If you are running a dedicated server, ensure that you provide the same arguments to `s2-plugify.exe` (or `s2-plugify`) as you would to `cs2.exe` (or `cs2`). For example:
91+
- If you are running a dedicated server, ensure that you provide the same arguments to `s2launcher.exe` (or `s2launcher`) as you would to `cs2.exe` (or `cs2`). For example:
9292
```bash
93-
s2-plugify.exe -dedicated -console -usercon +game_type 0 +game_mode 1 +map de_dust2
93+
s2launcher.exe -dedicated -console -usercon +game_type 0 +game_mode 1 +map de_dust2
9494
```
9595
This ensures that the launcher passes the correct parameters to the game executable.

0 commit comments

Comments
 (0)