tyler.durden
/
P3D-Legacy
mirror of https://github.com/P3D-Legacy/P3D-Legacy.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated README.md

This commit is contained in:
JappaWakkaP3D 2021-10-22 21:00:42 +02:00
parent 09fcd0254a
commit 5138bd974a
1 changed files with 25 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
README.md
View File

@ -9,7 +9,7 @@
<a href="https://discordapp.com/invite/EUhwdrq" target="_blank"><img src="https://img.shields.io/discord/299181628188524544" alt="Discord"></a>
</p>
The game is not in active development by [nilllzz](https://github.com/nilllzz) anymore, but few people from the community are maintaining the game and porting it to MonoGame platform.
The game is not in active development by the original developer [nilllzz](https://github.com/nilllzz) anymore, but a few people from the community are still developing and maintaining the game, hence the name P3D-Legacy.
You are free to fork and redistribute the code under the [GNU GPLv3 license](http://choosealicense.com/licenses/gpl-3.0/).
@ -17,22 +17,32 @@ You are free to fork and redistribute the code under the [GNU GPLv3 license](htt
You will find the latest release **[here](https://github.com/P3D-Legacy/P3D-Legacy/releases)**.
# Requirements for the game
# Instructions to play the game
* Go to the releases page (**[here](https://github.com/P3D-Legacy/P3D-Legacy/releases)**) and download the game (**you need the one that ends with "Release.zip"**) to a location where you can find it.
* After it has been downloaded, use an application like WinRAR or 7zip to extract the contents of the zip archive to a location of your preference.
* Navigate to the folder where you extracted the zip and double-click Pokemon3D.exe.
* Have fun playing Pokémon 3D!
In order to run the game, you will need the following:
* [OpenAL](https://www.openal.org/downloads/oalinst.zip)
If you want to play online on the official Pokémon 3D server, you need a GameJolt account and your game token (**[Click here if you don't know where to find your game token](https://gamejolt.com/f/how-to-find-your-user-token/291)**).
* Start the game, click on the GameJolt button in the Main Menu and enter your GameJolt username and your game token in the corresponding boxes.
* Click on the button that says "Log In" and when you're back in the Main Menu, select the new Savegame that appeared.
* If you want to play as a different character, check out the Skin Changer page on the Pokémon 3D homepage **[here](https://skin.pokemon3d.net/login)**.
* Log in with your GameJolt account
# Build instructions for the game
# Instructions to build the game from source
The game is written in Visual Basic and was compiled targeting the .NET Framework 4.6
The game is written in Visual Basic/VB.NET and was compiled targeting the .NET Framework 4.6
It is built using the MonoGame framework as graphics middleware.
In order to build the game's solution, you need the following:
* Microsoft Windows operating system (XP and up)
* [Microsoft Visual Studio](https://www.visualstudio.com/) (2010 and up)
* [MonoGame 3.7](http://www.monogame.net/downloads/)
* [Microsoft Visual Studio Community Edition](https://www.visualstudio.com/) (2019 and up)
* [MonoGame 3.7.1 for Visual Studio](https://community.monogame.net/t/monogame-3-7-1/11173)
* [Visual C++ Redistributable Packages for Visual Studio 2012 Update 4](http://www.microsoft.com/en-NZ/download/details.aspx?id=30679)
* [Visual C++ Redistributable Packages for Visual Studio 2013](https://www.microsoft.com/en-us/download/details.aspx?id=40784)
Make sure you've cloned the repository to a filepath without any spaces in it. It won't build otherwise.
To run the game after a successful build, you also need an applicable graphics card that supports DirectX (version 9 minimum).
The first build of the game will take a little longer due to the MonoGame Content Pipeline building all assets for the first time.
@ -58,11 +68,10 @@ To generate a valid meta file for the current state of the files in the game, go
Const RUNVALIDATION As Boolean = True ' Instead of False
Also, be sure to turn off the *IS_DEBUG_ACTIVE* in the *Core/GameController.vb* file.
Also, be sure to set the Solution Configuration at the top of the screen to Release instead of Debug.
Then build and debug-run the game. The console output of during the game's launch will output an expected size and metahash value.
It will also produce an updated "meta" file.
Then build and debug-run the game. The console output during the game's launch will output an expected size and metahash value.
It will also produce an updated "meta" file in the "P3D\bin\Release\" folder. Copy this to the main project folder (that's called P3D) and replace the file that's already there.
Stop the debugging of the game and copy these two values into the correct places at the top of the FileValidation code:
@ -71,11 +80,13 @@ Stop the debugging of the game and copy these two values into the correct places
Once you have done this, disable the *RUNVALIDATION* variable again and build the game again to have it boot up like normal.
If you want to continue working on the code, it is recommended to set the Solution Configuration at the top of the screen back to Debug instead of Release.
# Development
The game includes a switch to enable debug mode that makes map development or general fooling around easier.
The game has a Solution Configuration that enables debug mode which makes map development or general fooling around easier.
Locate the file *Core/GameController.vb* and set the *IS_DEBUG_ACTIVE* const to *True*, then rebuild the game.
Set the Solution Configuration at the top of the screen to Debug (not Release), then rebuild the game.
This is basically the Sandbox Mode that can be enabled in the game's save files plus these features: