Skip to content

imfoollink/NPLRuntime

 
 

Repository files navigation

Welcome to the TruckStar variant of NPLRuntime!

Terminology

original NPLRuntime: The original one created and maintained by Xizhi: https://github.com/LiXizhi/NPLRuntime

Definition and Usage for each branch:

mirror This is and will always be exactly the same as THE Original NPLRuntime, you should never try to push to this branch (AND you can't either btw).

send_back An example branch for sending codes back to original NPLRuntime, see "How to send my codes back to original NPLRuntime"

truck_star_develop The main branch of TruckStar under development.

master Not your business, forget about it.

Workflow for TruckStar Developers

General workflow

  1. Clone this repository to your local disk and checkout the truck_star_develop branch, which will be your main working place unless it's more appropriate to create a dedicated branch for your feature.
  2. The simple workflow of Pulling->Merging/Rebasing->Pushing will do in most cases. But it's also fine for you to create any branch for specific function or feature and push it up as you like, just remember to merge it back into truck_star_develop when you consider it finished.

How to build

Preparation:

  • Install VS2017 Community.
  • Download and Install CMake GUI 3.5 or later.
  • Install DXSDK_Jun10.exe (the latest one, from then on, dxsdk is included in Windows SDK)
  • Clone http://<your_name>@10.0.1.201/FrontEnd/NPLRuntime_truck_star.git into your local computer ( your_local_git_path/NPLRuntime_truck_star ).
  • Checkout branch: origin/truck_star_develop ( which means creating a local branch "truck_star_develop that tracks remote branch "origin/truck_star_develop" )
  • Download boost_1_64_0.rar from ftp://10.0.1.201/NPL_SDK/DEVKIT/boost_1_64_0.rar
  • Extract boost_1_64_0.rar into your_local_git_path/NPLRuntime_truck_star/Server/trunk/ and rename it to "boost_1_61_0", so it will be like this: your_local_git_path/NPLRuntime_truck_star/Server/trunk/boost_1_61_0/...

Build:

  • Run Cmake, set "Where is the source code" to: "your_local_git_path/NPLRuntime_truck_star" "where to build the binaries" to: "your_vs_project_path_for_nplruntime" (which basically means whatever-folder-you-like)
  • Click "Configure", Select "VisualStudio 2017" Toolset.
  • When configure finished, there will be an option "PARAENGINE_CLIENT_DLL" with a default "off" value. Tick it "on".
  • Click "Configure" again, there should be no errors (only warnings), ignore them.
  • Click "Generate".
  • VS project and solutions should be successfully generated in "your_vs_project_path_for_nplruntime".
  • Open "your_vs_project_path_for_nplruntime/ParaEngine.sln" with VS2017
  • Choose Debug or Release, build solution.
  • Check your_vs_project_path_for_nplruntime/Client/trunk/ParaEngineClient/Debug (or Release), PaperStar[_d].dll should be the thing you want.
  • Done.

How to run and test:

  • Copy the newly generated "PaperStar.dll" and "PaperStar.exe" into TruckStarClient/ClientMain/redist/
  • Run YouCraft_32bits.bat

Notes:

  • treat "truck_star_develop" branch as the real master, and DO NOT mess around with the so-named "master" branch. Only commit to "truck_star_develop" or other branches created by yourself.
  • Inform me (Cellfy) if you have features done and want it to be integrated into official NPLRuntime.
  • Remember: DO NOT Edit source files within Visual Studio unless you're absolutely sure the line endings is set to Unix Convention (LF), or it may cause problem building Linux Version. Since there's no convenient way to do this in VS itself, maybe you will need 3rd party plugin such as Strip'em.

How to send your codes back to original NPLRuntime

  1. Stash your local changes (if any) and checkout mirror branch.
  2. Create a new branch from mirror, with a name starting with "send_back", for example send_back_avatar, and start working on it.
  3. Push your local send_back_xxx onto the remote repository (currently 201), which means creating a new remote branch called send_back_xxx on the remote repository.
  4. Notify me (Cellfy) and tell me your branch name, say, "I want my codes send_back_xxx integrated into NPLRuntime, do that for me". Then i will do that for you. No thanks, but several roasted shashlik sticks in return will be appreciated ;D.
  5. Actually i say "i will do that for you" just means i will send a pull request to xizhi with your branch, so when exactly the request will be merged back into mirror can not be guaranteed.

About

NPL - Neural Parallel Language

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C++ 49.0%
  • C 44.6%
  • Makefile 1.0%
  • Lua 0.8%
  • Objective-C 0.7%
  • CMake 0.7%
  • Other 3.2%