|
|
|
|
@@ -1,303 +1,181 @@
|
|
|
|
|
# Cosmic - MapleStory v83 server
|
|
|
|
|
# Cosmic
|
|
|
|
|
Cosmic is a server emulator for Global MapleStory (GMS) version 83.
|
|
|
|
|
|
|
|
|
|
## Introduction
|
|
|
|
|
Cosmic launched as a successor to HeavenMS on March 21st 2021.
|
|
|
|
|
|
|
|
|
|
HeavenMS is archived, ie. it receives no further updates. This project aims to continue its development; mainly by improving code quality and make getting into PS development as easy as possible.
|
|
|
|
|
Cosmic launched on March 2021. It is based on code from a long line of server emulators spanning over a decade - starting with OdinMS (2008) and ending with HeavenMS (2019).
|
|
|
|
|
|
|
|
|
|
This is an open source project. Anyone may contribute by opening a pull request.
|
|
|
|
|
This is mainly a Java based project, but there are also a bunch of scripts written in JavaScript.
|
|
|
|
|
|
|
|
|
|
Only the server side is maintained. The client is directly copied from HeavenMS.
|
|
|
|
|
Head developer and maintainer: __Ponk__.\
|
|
|
|
|
Contributors: a lot of people over the years, and hopefully more to come. Big thanks to everyone who has contributed so far!
|
|
|
|
|
|
|
|
|
|
Join the Discord server where most of the discussions take place: https://discord.gg/JU5aQapVZK
|
|
|
|
|
|
|
|
|
|
Beware - ***This server emulator is not production ready.***
|
|
|
|
|
It can be useful for testing things locally or for trying out ideas, but launching a new private server based on this and opening it up to the public
|
|
|
|
|
without knowing what you're doing is not recommended.
|
|
|
|
|
### Goals
|
|
|
|
|
What we are working towards.
|
|
|
|
|
* __Vanilla gameplay__ - stay as close to the original game as possible (within reason).
|
|
|
|
|
* __Ease of use__ - getting started should be frictionless and contributing to the project straightforward.
|
|
|
|
|
* __Reduce technical debt__ - making changes should be easy without causing unintended side effects.
|
|
|
|
|
* __Modern tools & technologies__ - stay appealing by continuously improving the code and the project as a whole.
|
|
|
|
|
|
|
|
|
|
### Non-goals
|
|
|
|
|
Explicitly excluded from the scope of the project.
|
|
|
|
|
* __Custom gameplay features__ - existing custom features will be removed over time and new ones are unlikely to be added.
|
|
|
|
|
* __Client development__ - this project is focused on the server. Please go elsewhere for client related questions.
|
|
|
|
|
* __Public server__ - there will not be an official Cosmic server open to the public. Feel free to launch your own server __at your own risk__. No support will be provided.
|
|
|
|
|
|
|
|
|
|
## Development information
|
|
|
|
|
## Project setup
|
|
|
|
|
|
|
|
|
|
### Status (updated 2022-10-16)
|
|
|
|
|
### Contribute
|
|
|
|
|
You may contribute to the project in various ways, mainly through GitHub:
|
|
|
|
|
* Providing improvements to the code through a [Pull Request](https://github.com/P0nk/Cosmic/pulls) from your own fork.
|
|
|
|
|
* Reporting a bug by creating an [Issue](https://github.com/P0nk/Cosmic/issues).
|
|
|
|
|
* Providing information to existing issues or reviewing pull requests that others have made.
|
|
|
|
|
* ...and in other ways that I haven't thought of!
|
|
|
|
|
|
|
|
|
|
Development is currently <span style="color:Yellow">**sporadic**</span>.
|
|
|
|
|
### Continuous integration
|
|
|
|
|
A GitHub Actions pipeline is set up to run the build automatically when a new pull request is opened or commits are pushed to an existing one. This ensures that the code compiles and all the tests pass.
|
|
|
|
|
|
|
|
|
|
My time is very limited nowadays, but I try to keep up with the submitted pull requests. I may submit some stuff of my own, once in a while.
|
|
|
|
|
Once a pull request is merged, a tag with the new version is automatically created.
|
|
|
|
|
|
|
|
|
|
### Ways to contribute
|
|
|
|
|
|
|
|
|
|
* Submit a Pull Request (fork -> commit -> PR). If you don't know where to start, have a look at the issues on GitHub.
|
|
|
|
|
* Report a bug (preferably as an Issue on GitHub, as reports on Discord may be forgotten or lost)
|
|
|
|
|
* Spread the word about Cosmic
|
|
|
|
|
|
|
|
|
|
### Working with GitHub
|
|
|
|
|
|
|
|
|
|
Anyone with a GitHub account can contribute by making some changes in a branch and opening up a PR.
|
|
|
|
|
|
|
|
|
|
All activity on the GitHub repo (opening PR, commenting, creating issue, etc.) is automatically pushed (via webhook) to a public Discord channel for visibility.
|
|
|
|
|
|
|
|
|
|
Issues is the main place where bugs, issues or general improvements are tracked. Feel free to submit a new issue, but please keep it in English. By providing a good description, you increase the chance of a bug being fixed.
|
|
|
|
|
|
|
|
|
|
Tasks (past, present and future) are kept in the Cosmic project, which you get to via the "Projects" tab. This gives you an idea of where the project is moving.
|
|
|
|
|
### Discord integration
|
|
|
|
|
Most GitHub activity is pushed to a Discord channel for visibility. This works by leveraging a webhook. The activity includes (but is not limited to): merged commits, created PRs, comments, and new tags.
|
|
|
|
|
|
|
|
|
|
### Versioning
|
|
|
|
|
|
|
|
|
|
The project follows the [SemVer](https://semver.org/) versioning scheme using git tags.
|
|
|
|
|
As a pull request gets merged, a new version is automatically created.
|
|
|
|
|
|
|
|
|
|
Bug fixes result in bumped patch version: 1.2.__3__ -> 1.2.__4__
|
|
|
|
|
|
|
|
|
|
General improvements result in bumped minor version: 1.__2__.3 -> 1.__3__.3
|
|
|
|
|
|
|
|
|
|
Major changes result in bumped major version: __1__.2.3 -> __2__.2.3
|
|
|
|
|
|
|
|
|
|
### Cosmic
|
|
|
|
|
|
|
|
|
|
- GitHub: https://github.com/P0nk/Cosmic
|
|
|
|
|
- Discord: https://discord.gg/JU5aQapVZK
|
|
|
|
|
|
|
|
|
|
### HeavenMS
|
|
|
|
|
- GitHub: https://github.com/ronancpl/HeavenMS
|
|
|
|
|
- Discord: https://discord.gg/Q7wKxHX
|
|
|
|
|
|
|
|
|
|
## Tools / downloads
|
|
|
|
|
* **Java 17 SDK** - Needed to compile and run Java code. Install manually or through IntelliJ depending on how you prefer to launch the server. Not required for launching with Docker.
|
|
|
|
|
* Link: https://jdk.java.net/17/
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* **IntelliJ IDEA** - Java IDE and your main tool for working with the source code. Community edition is good enough.
|
|
|
|
|
* Link: https://www.jetbrains.com/idea/
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* **MySQL Community Server 8** - Database for game data.
|
|
|
|
|
* Link: https://dev.mysql.com/downloads/mysql/
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* **MySQL Workbench 8** - Client for interacting with the database. Other clients do exist.
|
|
|
|
|
* Link: https://dev.mysql.com/downloads/workbench/
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* **Docker Desktop** (optional) - For launching the game locally with less hassle.
|
|
|
|
|
* Link: https://www.docker.com/products/docker-desktop
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* **Client files and general tools**
|
|
|
|
|
* Link: https://drive.google.com/drive/folders/1hgnb92MGL6xqEp9szEMBh0K9pSJcJ6IT?usp=sharing
|
|
|
|
|
* This is Ponk's own Google Drive, similar to how Ronan provides files for HeavenMS.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### MapleStory client
|
|
|
|
|
|
|
|
|
|
- Latest localhost client: https://hostr.co/amuX5SLeeVZx
|
|
|
|
|
|
|
|
|
|
**Important note about localhost clients**: these executables are red-flagged by antivirus tools as __potentially malicious software__,
|
|
|
|
|
this happens due to the reverse engineering methods that were applied onto these software artifacts.
|
|
|
|
|
Those depicted here have been put to use for years already and posed no harm so far, so they are soundly assumed to be safe.
|
|
|
|
|
|
|
|
|
|
The project follows the [semantic versioning](https://semver.org/) scheme using git tags.
|
|
|
|
|
* *Bug fixes* are treated as PATCH: 1.2.__3__ -> 1.2.__4__
|
|
|
|
|
* *General changes or improvements* are treated as MINOR: 1.__2__.3 -> 1.__3.0__
|
|
|
|
|
* *Major changes* are treated as MAJOR: __1__.2.3 -> __2.0.0__
|
|
|
|
|
|
|
|
|
|
## Getting started
|
|
|
|
|
The localhost MapleStory client needs to be installed, as well as the server that will host the game.
|
|
|
|
|
Follow along as I go through the steps to play the game on your local computer from start to finish. I won't go into extreme detail, so if you don't have prior experience with Java or git, you might struggle.
|
|
|
|
|
|
|
|
|
|
### Installing the client
|
|
|
|
|
We will set up the following:
|
|
|
|
|
- Database - the database is used by the server to store game data such as accounts, characters and inventory items.
|
|
|
|
|
- Server - the server is the "brain" and routes network traffic between the clients.
|
|
|
|
|
- Client - the client is the application used to _play the game_, i.e. MapleStory.exe.
|
|
|
|
|
|
|
|
|
|
1. Install MapleStory with "MapleGlobal-v83-setup.exe" in your folder of choice (e.g. "C:\Nexon\MapleStory") and follow their instructions.
|
|
|
|
|
2. Once done, erase these files: "HShield" (folder), "ASPLnchr.exe", "MapleStory.exe" and "Patcher.exe".
|
|
|
|
|
3. Extract into the client folder the "HeavenMS-localhost-WINDOW.exe" (from now on referred to as "localhost.exe") from the provided link.
|
|
|
|
|
4. Overwrite the original WZ files with the ones provided on the Google Drive: "CosmicWZ-v1-2021.05.10.zip"
|
|
|
|
|
- This is currently identical to the latest HeavenMS WZ files (except for the file name): "commit397_wz-20210321T173600Z-001.zip"
|
|
|
|
|
### 1 - Database
|
|
|
|
|
You will start by installing the database server and client, and then run some scripts to prepare it for the server.
|
|
|
|
|
|
|
|
|
|
#### Editing localhost IP target
|
|
|
|
|
#### Steps
|
|
|
|
|
|
|
|
|
|
If you are not using "localhost" as the target IP on the server's config file, you will need to HEX-EDIT localhost.exe to fetch your IP. Track down all IP locations by searching for "Type: String" "127.0.0.1", and applying the changes wherever it fits.
|
|
|
|
|
1. Download and install [MySQL Community Server 8+](https://dev.mysql.com/downloads/mysql/). You will have to set a root password, make sure you don't lose it because you will need it later.
|
|
|
|
|
2. Download and install [HeidiSQL](https://www.heidisql.com/download.php).
|
|
|
|
|
3. Open HeidiSQL and connect to the database ("New" -> "Session in root folder" -> fill in password -> "Open").
|
|
|
|
|
4. Run all four scripts located in database/sql in order. Starting with ``1-db_database.sql`` and ending with ``4-db-admin.sql``. In HeidiSQL: "File" -> "Run SQL File...".
|
|
|
|
|
5. The database is ready!
|
|
|
|
|
|
|
|
|
|
To hex-edit, install the Neo Hex Editor from "free-hex-editor-neo.exe" and follow their instructions. Once done, open localhost.exe for editing and overwrite the IP values under the 3 addresses. Save the changes and exit the editor.
|
|
|
|
|
### 2 - Server
|
|
|
|
|
You will start by cloning the repository, then configure the database properties and lastly start the server.
|
|
|
|
|
|
|
|
|
|
(TODO: find suitable alternative to Neo Hex Editor)
|
|
|
|
|
#### Prerequisites
|
|
|
|
|
* Java 21+ (I recommend [Amazon Corretto](https://aws.amazon.com/corretto))
|
|
|
|
|
* IDE (I recommend [IntelliJ IDEA](https://www.jetbrains.com/idea/))
|
|
|
|
|
|
|
|
|
|
#### Testing the localhost
|
|
|
|
|
#### Steps
|
|
|
|
|
|
|
|
|
|
Open the "localhost.exe" client.
|
|
|
|
|
If by any means the program did not open, and checking the server log your ping has been listened by the server
|
|
|
|
|
and you are using Windows 8, 10 or 11, it is probably some compatibility issue.
|
|
|
|
|
1. Clone Cosmic into a new project. In IntelliJ, you would create a new project from version control.
|
|
|
|
|
2. Open _config.yaml_. Find "DB_PASS" and set it to your database root user password.
|
|
|
|
|
3. Start the server. The main method is located in `net.server.Server`.
|
|
|
|
|
4. If you see "Cosmic is now online" in the console, it means the server is online and ready to serve traffic. Yay!
|
|
|
|
|
|
|
|
|
|
In some cases it helps to spam click the exe a few times (2-3 times usually works for me on W10).
|
|
|
|
|
Below, I list other ways of running the server which are completely optional.
|
|
|
|
|
|
|
|
|
|
In that case, extract "lolwut.exe" from "lolwut-v0.01.rar" and place it on the MapleStory client folder ("C:\Nexon\MapleStory").
|
|
|
|
|
Your "localhost.exe" property settings must follow these:
|
|
|
|
|
#### Docker
|
|
|
|
|
Support for Docker is also provided out of the box, as an alternative to running straight in the IDE. If you have [Docker Desktop](https://www.docker.com/products/docker-desktop/) installed it's as easy as running `docker compose up`.
|
|
|
|
|
|
|
|
|
|
Note: "lolwut.exe" is currently not available in the Google Drive.
|
|
|
|
|
Making changes becomes a bit more tedious though as you have to rebuild the server image via `docker compose up --build`.
|
|
|
|
|
|
|
|
|
|
* Run in compatibility mode: Windows 7;
|
|
|
|
|
* Unchecked reduced color mode;
|
|
|
|
|
* 640 x 480 resolution;
|
|
|
|
|
* Unchecked disable display on high DPI settings;
|
|
|
|
|
* Run as an administrator;
|
|
|
|
|
* Opening "lolwut.exe", use Fraysa's method.
|
|
|
|
|
On the first launch, the database container will run the scripts which may take so long that the server fails to start. In that case, just wait until the database is done running the scripts and then retry (Ctrl+C and re-run the command).
|
|
|
|
|
|
|
|
|
|
Important: should the client be refused a connection to the game server, it may be because of firewall issues. Head to the end of this file to proceed in allowing this connection through the computer's firewall. Alternatively, one can deactivate the firewall and try opening the client again.
|
|
|
|
|
You can also search the server logs (/logs/cosmic-log.log) if any connection attempts have been made to ease debugging.
|
|
|
|
|
#### Jar
|
|
|
|
|
Another option is to start the server from a terminal by running a jar file. You first need to build the jar file from source which requires [Maven](https://maven.apache.org/).
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
### Installing the server
|
|
|
|
|
1. Configure the project
|
|
|
|
|
2. Set up the database
|
|
|
|
|
3. Launch the server
|
|
|
|
|
Building the jar file is as easy as running ``mvn clean package``. The project is configured to produce a "fat" jar which contains all dependencies (by utilizing the _maven-assembly-plugin_). Note that the WZ XML files are __not__ included in the jar.
|
|
|
|
|
|
|
|
|
|
If you are using Docker (quick start):
|
|
|
|
|
1. Configure the project
|
|
|
|
|
2. Launch the server
|
|
|
|
|
To run the jar, a ``launch.bat`` file is provided for convenience. Simply double-click it and the server will start in a new terminal window.
|
|
|
|
|
|
|
|
|
|
#### Configuring the project
|
|
|
|
|
Alternatively, run the jar file from the terminal. Just remember to provide the `wz-path` system property pointing to your wz directory.
|
|
|
|
|
|
|
|
|
|
The easiest way to set up your project is to clone the repository directly into a new IntelliJ project.
|
|
|
|
|
### 3 - Client
|
|
|
|
|
You will start by installing the game with the old installer, then overwrite some WZ files with our custom ones, and lastly get the localhost executable in place.
|
|
|
|
|
|
|
|
|
|
1. Install IntelliJ
|
|
|
|
|
2. Create a new "Project from Version Control..."
|
|
|
|
|
3. Enter the URL to this GitHub repository: "https://github.com/P0nk/Cosmic.git"
|
|
|
|
|
4. Click on "Clone". A new project will now be created with all the files from the repository.
|
|
|
|
|
#### Steps
|
|
|
|
|
|
|
|
|
|
#### Setting up the database
|
|
|
|
|
1. Download _MapleGlobal-v83-setup.exe_ from my [Google Drive](https://drive.google.com/drive/folders/1hgnb92MGL6xqEp9szEMBh0K9pSJcJ6IT). This is the official installer from back then.
|
|
|
|
|
2. Install it in a directory of your choice.
|
|
|
|
|
3. Delete the following files from the installation directory: _HShield_ (entire directory), _ASPLnchr.exe_, _MapleStory.exe_, and _Patcher.exe_.
|
|
|
|
|
4. Download _CosmicWZ-v1-2021.05.10.zip_ from my [Google Drive](https://drive.google.com/drive/folders/1hgnb92MGL6xqEp9szEMBh0K9pSJcJ6IT).
|
|
|
|
|
5. Unzip it and copy all .wz-files into the installation directory. Replace the existing ones.
|
|
|
|
|
6. Download _HeavenMS-localhost-WINDOW.exe_ from [hostr.co](https://hostr.co/amuX5SLeeVZx). This is a client modified to connect to your localhost instead of Nexon's server (along with some fixes and custom changes).
|
|
|
|
|
- Your antivirus will likely detect the file as a trojan or similar and automatically delete it. To prevent this from happening, add your _Downloads_ directory and the installation directory as exclusions in your antivirus software. On W11, this is under "Virus & threat protection settings" -> "Add or remove exclusions".
|
|
|
|
|
7. Move _HeavenMS-localhost-WINDOW.exe_ into the installation directory.
|
|
|
|
|
8. Done! Double-click the exe and the game should start.
|
|
|
|
|
- The client may be a bit fiddly. Sometimes it won't start, but if you see "Client connected" in the server console it's a good indication. Try spam-clicking it like 10+ times, that usually works for me.
|
|
|
|
|
|
|
|
|
|
1. Install MySQL Server 8 and MySQL Workbench 8.
|
|
|
|
|
2. Using Workbench, create a new user with username "cosmic_server" and password "snailshell".
|
|
|
|
|
This the default configuration in Cosmic.
|
|
|
|
|
* (Optional) Restrict the Schema Privileges for this new user for improved security.
|
|
|
|
|
Add a new entry with "Schemas matching pattern: cosmic" and only select "SELECT", "INSERT", "UPDATE", "DELETE" under "Object Rights"
|
|
|
|
|
3. Run the sql scripts in the "database/sql" directory of the project in the order indicated by their names.
|
|
|
|
|
* Make sure you are connected to the database with the "root" user to be able to run the scripts.
|
|
|
|
|
* Run scripts one by one through the menu: "File" -> "Run SQL Script" -> select the script file to run -> "Run"
|
|
|
|
|
* The 3rd script "3-db_shopupdate" is optional. It adds custom shop items for certain NPCs.
|
|
|
|
|
* The 4th script "4-db_admin" is also optional, but recommended if you are new. It adds an admin account to simplify the setup.
|
|
|
|
|
**Important note about localhost clients**: these executables are red-flagged by antivirus tools as potentially malicious software.
|
|
|
|
|
This happens due to the reverse engineering methods that were applied onto these software artifacts.
|
|
|
|
|
The one provided here has been in use for years already and posed no harm so far, so it is assumed to be safe.
|
|
|
|
|
|
|
|
|
|
Use this info when you connect to MySQL Server for the first time:
|
|
|
|
|
* Server Host: localhost
|
|
|
|
|
* Port: 3306
|
|
|
|
|
* Username: root
|
|
|
|
|
* Password: <whatever password you set during MySQL Server installation>
|
|
|
|
|
### 4 - Getting into the game
|
|
|
|
|
The client has started, and you're looking at the login screen.
|
|
|
|
|
|
|
|
|
|
At the end of the execution of these sql scripts, you should have installed a database schema named "cosmic".
|
|
|
|
|
REGISTER YOUR FIRST ACCOUNT to be used in-game by **manually creating** an entry in the table "accounts" in the database with a username and password.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### Running the server
|
|
|
|
|
|
|
|
|
|
Configure the IP you want to use for your MapleStory server in "config.yaml" file, or set it as "localhost" if you want to run it only on your machine.
|
|
|
|
|
Alternatively, you can use the IP given by Hamachi to use on a Hamachi network, or you can use a non-Hamachi method of port-forwarding. Neither will be approached here.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
To launch the server, you may either:
|
|
|
|
|
* Launch inside IntelliJ
|
|
|
|
|
* Launch a built jar file
|
|
|
|
|
* Launch with Docker
|
|
|
|
|
|
|
|
|
|
#### Run inside IntelliJ
|
|
|
|
|
1. Open the file src/main/java/net/server/Server.java.
|
|
|
|
|
2. Click the green arrow to the left of the class definition "public class Server", and then "Run Cosmic".
|
|
|
|
|
* Alternatively (recommended), create a new Configuration that points to "net.server.Server".
|
|
|
|
|
3. The server launches in a terminal window inside IntelliJ.
|
|
|
|
|
|
|
|
|
|
#### Run from a jar file
|
|
|
|
|
1. Create the jar file
|
|
|
|
|
* The jar file is created by the Maven assembly plugin in the package lifecycle.
|
|
|
|
|
* If you already have Maven installed, simply run the command "mvn clean install" to create the jar file.
|
|
|
|
|
* IntelliJ also comes with built-in Maven support. Open a new terminal window inside IntelliJ, type "mvn clean install" (your command should now be marked green), then Ctrl+Enter to build the jar file.
|
|
|
|
|
2. Launch the jar file
|
|
|
|
|
* Double click on "launch.bat" (need to have Java 17 installed)
|
|
|
|
|
|
|
|
|
|
#### Run as containers with Docker
|
|
|
|
|
1. Start Docker
|
|
|
|
|
2. Run the command "docker compose up" at the root of the project.
|
|
|
|
|
* If you make any changes to the code, make sure you append the "--build" option at the end of the command to force rebuild the server image.
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
### Getting into the game
|
|
|
|
|
|
|
|
|
|
If you ran the admin sql script, there already exists an account in the database with an admin character on it (GM level 6).
|
|
|
|
|
|
|
|
|
|
Log in using these credentials:
|
|
|
|
|
#### Logging in
|
|
|
|
|
At this point, you can log in to the admin account using the following credentials:
|
|
|
|
|
* Username: "admin"
|
|
|
|
|
* Password: "admin"
|
|
|
|
|
* Pin: "0000"
|
|
|
|
|
* Pic: "000000"
|
|
|
|
|
|
|
|
|
|
Admin characters have "hide" mode enabled by default. This means your character will be translucent on your screen, and completely invisible to others.
|
|
|
|
|
It will also prevent you from controlling mobs (making them stand still). To toggle this mode on and off, type "@hide" in the in-game chat.
|
|
|
|
|
Or create a regular account by typing in your desired username & password and attempting to log in. This "automatic registration" feature lets you create new accounts to play around with. It is enabled by default (see _config.yaml_).
|
|
|
|
|
|
|
|
|
|
By default, the server source is set to allow AUTO-REGISTERING. This means that, by simply typing in a "Login ID" and a "Password", you're able to create a new account.
|
|
|
|
|
#### Entering the game
|
|
|
|
|
Create a new character as you normally would, and then select it to enter the game. Hooray, finally we're in!
|
|
|
|
|
|
|
|
|
|
After creating a character, experiment typing in all-chat "@commands".
|
|
|
|
|
This will display all available commands for the current GM level your character has.
|
|
|
|
|
If you log in to the "Admin" character, you'll notice that the character looks almost invisible. This is hide mode, which is enabled by default when you log in to a GM character. You won't be visible to normal players and no mobs will move if you're alone on the map. Toggle hide mode on or off by typing "@hide" in the in-game chat.
|
|
|
|
|
|
|
|
|
|
To change a character's GM level, make sure that character is not logged in, then:
|
|
|
|
|
Hide is one of many commands available to players, type "@commands" to see the full list. Higher ranked GMs have access to more powerful commands.
|
|
|
|
|
|
|
|
|
|
1. Open MySQL Workbench;
|
|
|
|
|
2. Expand "cosmic" schema;
|
|
|
|
|
3. Expand "Tables";
|
|
|
|
|
4. Right-click "characters" and click "Select Rows"
|
|
|
|
|
5. Find your character in Result Grid. Scroll to the right and find the "gm" column.
|
|
|
|
|
6. Edit your character's gm value and click "Apply", and then "Apply" again in the window that appeared, then "Finish".
|
|
|
|
|
* 0 is what ordinary players start with, and 6 is the highest gm value. Higher level gms have access to more commands in game.
|
|
|
|
|
That's it, have fun playing around in game!
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
### Some notes about WZ/WZ.XML EDITING
|
|
|
|
|
Brief introduction to WZ files: they are the asset/data files required by the client and server. The client can read the .wz files directly, but the server requires them in XML format.
|
|
|
|
|
The server also does not make use of any of the sprites, which is where different kinds of exporting comes into the picture. HaRepacker allows you to export to Private server XML, which is the .img files packaged in the .wz stripped of sprites and converted to XML.
|
|
|
|
|
## Advanced concepts
|
|
|
|
|
Some slightly more advanced concepts that might be useful once you're up and running.
|
|
|
|
|
|
|
|
|
|
Link to HaRepacker-resurrected, the standard tool for handling WZ files: https://github.com/lastbattle/Harepacker-resurrected
|
|
|
|
|
### Host on remote server
|
|
|
|
|
You don't have to host the server on your local machine to play. It's possible to host on a remote server such as a VPS or even a dedicated server.
|
|
|
|
|
|
|
|
|
|
NOTE: Be extremely wary when using server-side's XMLs data being reimported into the client's WZ, as some means of synchronization between the server and client modules, this action COULD generate some kind of bugs afterwards. Client-to-server data reimporting seems to be fine, though.
|
|
|
|
|
I leave it to you to figure out the server hosting part, but once you have that running you'll need to edit the client exe to point to your remote server ip.
|
|
|
|
|
|
|
|
|
|
#### Editing the v83 WZ's:
|
|
|
|
|
#### Edit client ip
|
|
|
|
|
1. Download and install a hex editor: [HxD](https://mh-nexus.de/en/hxd/)
|
|
|
|
|
2. Start HxD and open your client exe (I recommend making a copy of it first). At this point you should see a bunch of hex codes and a "Decoded text" column to the right of it.
|
|
|
|
|
3. Ctrl+f and search for Text-string "127.0.0.1". You should find three occurrences right above each other.
|
|
|
|
|
4. Place your cursor before the first "127" and start typing the desired ip, overwriting what is already there. Do the same on the other two and click on Save.
|
|
|
|
|
5. Done! Now the client will attempt to connect to that ip address instead when you launch it.
|
|
|
|
|
|
|
|
|
|
### WZ files
|
|
|
|
|
WZ files are the asset/data files required by the client and server. Typically, [HaRepacker-resurrected](https://github.com/lastbattle/Harepacker-resurrected) is used to handle (view, edit, export) the .wz files.
|
|
|
|
|
|
|
|
|
|
* Use the HaRepacker-resurrected 4.2.4 editor, encryption "GMS (old)".
|
|
|
|
|
* Open the desired WZ for editing and use the node hierarchy to make the desired changes (copy/pasting nodes may be unreliable in rare scenarios).
|
|
|
|
|
* Save the changed WZ, **overwriting the original content** at the client folder.
|
|
|
|
|
* Finally, **RE-EXPORT (using the "Private Server..." exporting option) the changed XMLs into the server's WZ.XML files**, overwriting the old contents.
|
|
|
|
|
The client can read the .wz files directly, but the server requires them in XML format. The server also does not make use of the sprites, which is the motivation for different kinds of exporting.
|
|
|
|
|
HaRepacker allows you to export to "Private server", which is the .img files packaged in the .wz stripped of sprites and converted to XML. This takes much less disk space.
|
|
|
|
|
|
|
|
|
|
**These steps are IMPORTANT, to maintain synchronization** between the server and client modules.
|
|
|
|
|
This server requires custom .wz files (unfortunately), as you may have noted during installation of the client. The intention is for these to be removed eventually and to solely run on vanilla .wz files.
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
### Portforwarding the SERVER
|
|
|
|
|
#### WZ editing
|
|
|
|
|
* Use the HaRepacker-resurrected editor, encryption "GMS (old)".
|
|
|
|
|
* Open the desired .wz for editing and use the node hierarchy to make the desired changes (copy/pasting nodes may be unreliable in rare scenarios).
|
|
|
|
|
* Save the changed .wz, overwriting the original content at the client folder.
|
|
|
|
|
* Finally, re-export (using the "Private Server" exporting option) the changed XMLs into the server's .wz XML files (found in the "wz" directory), overwriting the old contents.
|
|
|
|
|
|
|
|
|
|
To use portforward, you will need to have permission to change things on the LAN router. Access your router using the Internet browser. URLs vary accordingly with the manufacturer. To discover it, open the command prompt and type "ipconfig" and search for the "default gateway" field. The IP shown there is the URL needed to access the router. Also, look for the IP given to your machine (aka "IPv4 address" field), which will be the server one.
|
|
|
|
|
Make sure to always export from the client .wz files to the server XML, and not the other way around.
|
|
|
|
|
|
|
|
|
|
The default login/password also varies, so use the link http://www.routerpasswords.com/ as reference. Usually, login as "admin" and password as "password" completes the task well.
|
|
|
|
|
Editing the client .wz without exporting to the server may lead to strange behavior.
|
|
|
|
|
|
|
|
|
|
Now you have logged in the router system, search for anything related to portforwarding. Should the system prompt you between portforwarding and portriggering, pick the first, it is what we will be using.
|
|
|
|
|
### Client features
|
|
|
|
|
For more information about the client and its features, see [HeavenMS on GitHub](https://github.com/ronancpl/HeavenMS#download-items).
|
|
|
|
|
|
|
|
|
|
Now, it is needed to enable the right ports for the Internet. For Cosmic, it is basically needed to open ports 7575 to 7575 + (number of channels) and port 8484. Create a new custom service which enables that range of ports for the server's channel and opt to use TCP/UDP protocols. Finally, create a custom service now for using port 8484.
|
|
|
|
|
|
|
|
|
|
Optionally, if you want to host a webpage, portforward the port 80 (the HTTP port) as well.
|
|
|
|
|
|
|
|
|
|
It is not done yet, sometimes the firewalls will block connections between the LAN and the Internet. To overcome this, it is needed to create some rules for the firewall to permit these connections. Search for the advanced options with firewalls on your computer and, with it open, create two rules (one outbound and one inbound).
|
|
|
|
|
|
|
|
|
|
These rules must target "one application", "enable connections" and must target your MapleStory client (aka localhost).
|
|
|
|
|
|
|
|
|
|
After all these steps, the portforwarding process should now be complete.
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
### Client changelog
|
|
|
|
|
The following list, in bottom-up chronological order,
|
|
|
|
|
holds information regarding all changes that were applied from the starting localhost used in this development.
|
|
|
|
|
Some lines have a link attached, that will lead you to a snapshot of the localhost at that version of the artifact.
|
|
|
|
|
Naturally, later versions holds all previous changes along with the proposed changes.
|
|
|
|
|
|
|
|
|
|
**Change log:**
|
|
|
|
|
|
|
|
|
|
* Fixed Monster Magnet crashing the caster when trying to pull fixed mobs, credits to Shavit. https://gofile.io/?c=BW7dVM (dead link)
|
|
|
|
|
* Cleared need for administrator privileges (OS) to play the game, credits to Ubaware.
|
|
|
|
|
* Set a higher cap for AP assigning with AP Reset, credits to Ubaware.
|
|
|
|
|
* Fixed Monster Magnet crashing the caster when trying to pull bosses. Drawback: Dojo HPBar becomes unavailable. https://hostr.co/SvnSKrGzXhG0
|
|
|
|
|
* Fixed some 'rn' problems with quest icons & removed "tab" from party leader changed message. https://hostr.co/tsYsQzzV6xT0
|
|
|
|
|
* Removed block on applying attack-based strengthening gems on non-weapon equipments. https://hostr.co/m2bVtnizCtmD
|
|
|
|
|
* Set a higher cap for SPEED.
|
|
|
|
|
* Removed the AP assigning block for beginners below level 10. https://hostr.co/AHAHzneCti9B
|
|
|
|
|
* Removed block on party for beginners level 10 or below. https://hostr.co/JZq53mMtToCz
|
|
|
|
|
* Removed block on MTS entering in some maps, rendering the buyback option available.
|
|
|
|
|
* Removed "AP excess" popup and limited actions on Admin/MWLB, credits to kevintjuh93.
|
|
|
|
|
* Removed "You've gained a level!" popup, credits to PrinceReborn.
|
|
|
|
|
* Removed caps for WATK, WDEF, MDEF, ACC, AVOID.
|
|
|
|
|
* 'n' problem fixed.
|
|
|
|
|
* Fraysa's https://hostr.co/gJbLZITRVHmv
|
|
|
|
|
* Eric's MapleSilver starting on window-mode.
|
|
|
|
|
Some notable features:
|
|
|
|
|
* Opens in window mode by default
|
|
|
|
|
* Uncapped max speed
|
|
|
|
|
|
