Jump to content
New Forum Update ×

If you have any questions while creating a MOD

NeoRider7

By NeoRider7
in Planetbase

 Share

Recommended Posts

NeoRider7 Contributor

NeoRider7

Posted
Posted (edited)

The information in this post is based on this guide from the Steam forum: https://steamcommunity.com/sharedfiles/filedetails/?id=2044971158

--------------

 

For whom is this guide:

This guide is made for those who are going to create a new mod for the game Planetbase.

 

--------------

Ideas for new mods:

 

Do you have a desire to make a good new mod?
The community of players has long been hungry for new mods! ;-)

 

Online resources with collections of ideas and suggestions:

 

  1. Guide "What would you like to improve in the game?" https://steamcommunity.com/sharedfiles/filedetails/?id=1999352524
  2. Reddit SUGGESTIONS THREAD
  3. Steam > Planetbase > Workshop > Discussions >
  4. Steam > Planetbase > Discussions >
  5. NexusMods

 

--------------

Mod settings

 

BASIC WISHES for mod customization:

  • Add instructions for installing and configuring the mod.
    It will take you a little time and will be of great benefit to a large number of players in the community.

     

  • Make a mod with the ability to edit and enable/disable parameters.
    This is usually done using a separate text file.

     

  • If possible, share the source code of the mod.
    Sooner or later, the community of players will come up with a way to make this mod even more interesting. If the author of the mod is not in touch at this moment, then other members of the community can improve the mod.

     

In more detail on this topic:
When creating a new mod, it is very desirable to make it with the ability to edit and enable / disable parameters.
This can be done using a separate text file where everyone without programming knowledge could change the text values ââthat change the balance in the game.

Use the power of the community! Give players a simple and easily customizable tool.
After that, the community of players will be able to experiment with the settings of the mod parameters and adjusting the balance in the game.
In this case, players will be able to share among themselves the text files of the mod configurator and jointly improve various options for game balance.
Ideally, if all goes well: completely different types of game can be created based on your mod, as different variants of the mod configuration text file will appear.

 

Mod configuration examples:

--------------

Two engines (platforms) for mods:

Now there are two main platforms (two main engines) mods on which mods are made for the game Planetbase.
(We will not mention other methods of creating and installing mods here, since they are much more complicated and are used by a significantly smaller number of players, only those who are well versed in programming).

Consider below these options for engines (platforms) for mods in chronological order.

 

1 - mod engine from JPFarias (2016)

1) The number one mod engine from 2016 (Created by JPFarias):

  1. Instructions for installing mods - "Planetbase Mods to add to your game" - https://steamcommunity.com/app/403190/discussions/0/3182216552764118049/
    (the text includes a list of mods from 2017, the list there is incomplete)
  2. VIDEO-Installation Instructions for mods -
    "Planetbase: How to Download Mods"
  3. Planetbase Mod Patcher https://www.nexusmods.com/planetbase/mods/1
  4. Redirector https://www.nexusmods.com/planetbase/mods/3
  5. F.A.Q. Mods, Cheats, Trainers for Planetbase: https://steamcommunity.com/sharedfiles/filedetails/?id=1981488180
  6. The most complete list of mods can be found at NexusMods, as well as in this guide "List of Mods": https://steamcommunity.com/sharedfiles/filedetails/?id=1981754832

 

2 - mod engine from Tahvohck (2020)

2) Number two mod engine from 2020 (Created by Tahvohck):

  1. Description from Tahvohck of the features of his platform and why he created it https://github.com/Tahvohck/Planetbase-Mods
  2. Unity Mod Manager Configuration https://www.nexusmods.com/planetbase/mods/43
  3. Planetbase Utilities https://www.nexusmods.com/planetbase/mods/45
  4. Mod 2.1: AutoConnections ReManaged https://www.nexusmods.com/planetbase/mods/46
  5. Mod 2.2: Building Aligner ReManaged https://www.nexusmods.com/planetbase/mods/47
  6. Mod 2.3: ComponentManager https://www.nexusmods.com/planetbase/mods/52
  7. For a complete list of mods see NexusMods and this guide "List of Mods": https://steamcommunity.com/sharedfiles/filedetails/?id=1981754832

 

3 - Self-contained mods:

3) Self-contained mods ( Planetbase custom code):
Self-sufficient mods are those mods for which you do not need to install separate engines (platforms) for mods (additional software).
As a rule, these are mods that already contain embedded software inside them. For example, such software as in the mod engine from JPFarias.
Pluses of these mods:
- for their work, you do not need to install additional software with the mod engine (platform).
Cons of these mods:
- most likely a similar mod will not work with other mods at the same time.

In this tutorial, you can find an example of a self-contained cheat-mod:

"List of Mods": https://steamcommunity.com/sharedfiles/filedetails/?id=1981754832

and here:

"Cheat-Mode": https://steamcommunity.com/sharedfiles/filedetails/?id=1983401261

 

--------------

How to make Mods:

 

A) for mods created on the JPFarias engine 2016:

 

A.1) How to make mods - "Modding using the Planetbase Framework" -
https://steamcommunity.com/sharedfiles/filedetails/?id=1266153227

 

A.2) Planetbase-Framework
https://github.com/solidDoWant/Planetbase-Framework/wiki/Creating-mods
author: solidDoWant
create a Request (Issues): https://github.com/solidDoWant/Planetbase-Framework/issues
add solidDoWant on Steam: http://steamcommunity.com/id/TheiInTEAM/
write solidDoWant on Discord: https://discord.gg/qufsVms

 

A.3) Utility library
Planetbase modding utilities library - https://github.com/Tahvohck/Planetbase-CommunityUtils
https://github.com/solidDoWant/Planetbase-Framework/wiki/Creating-mods
"Modding Roadmap and Updates" - https://steamcommunity.com/app/403190/discussions/0/385428943467513841/
Trello https://trello.com/b/y9mEYjdS/planetbase-modding

 

A.4) Wiki for programmers who want to create mods
https://bitbucket.org/joaofarias/planetbase-modding/wiki/Home
Posted by: João Farias
https://bitbucket.org/joaofarias/planetbase-modding

 

A.5) Planetbase Modding in TRELLO https://trello.com/b/y9mEYjdS/planetbase-modding

 

B) for mods created on the Tahvohck engine 2020:
B.1) Description from Tahvohck of the features of his platform and why he created it https://github.com/Tahvohck/Planetbase-Mods
B.2) Unity Mod Manager Configuration https://www.nexusmods.com/planetbase/mods/43
B.3) Planetbase Utilities https://www.nexusmods.com/planetbase/mods/45

--------------

 

 

If you have any questions:

 

If you have any questions while creating a mod:
So that the answer comes as quickly as possible, I advise you to place your question in these places:

 

1) Reddit https://www.reddit.com/r/Planetbase/
There are a lot more fans of the game than on Steam forums and the answers come faster.
For news on Reddit, many follow and quickly respond.

 

2) NexusMods
2.1) https://www.nexusmods.com/planetbase
2.2) Forum NexusMods https://forums.nexusmods.com/index.php?/forum/3659-general-planetbase-discussion

 

3) Create a separate new topic in Steam general discussions here: https://steamcommunity.com/app/403190/discussions/

 

4) Create a separate new topic in the discussions of the Game Workshop here: https://steamcommunity.com/workshop/discussions/?appid=403190

PAY ATTENTION: General desire to create a title for the topic of discussion: In the name of the topic of discussion, it is necessary, if possible, clearly and in detail to write your question or request for help.
If the topic of discussion is incomprehensible, then few people will go inside and read this topic.

 

5) Use the search to find topics for discussion related to the creation of mods.
Post your question in this thread.
As a rule, the participants in this discussion subscribe to these topics. If you publish your new message there with a question, then participants in this topic will see it and there is a good chance that they will respond.

 

6) Look at the program code that other fans of the game did when creating their mods.
For example, it is possible to see here:

 

6.1) github.com
https://github.com/solidDoWant/Planetbase/wiki/Writing-mods
https://github.com/solidDoWant/Planetbase-XMLModloaderMod
https://github.com/solidDoWant/Planetbase-Modpatcher/releases/tag/2.2
Planetbase-Framework:
https://github.com/solidDoWant/Planetbase-Framework/wiki/Creating-mods
Utility library
Planetbase modding utilities library - https://github.com/Tahvohck/Planetbase-CommunityUtils
https://github.com/solidDoWant/Planetbase-Framework/wiki/Creating-mods
"Modding Roadmap and Updates" - https://steamcommunity.com/app/403190/discussions/0/385428943467513841/
Trello https://trello.com/b/y9mEYjdS/planetbase-modding

 

6.2) bitbucket.org
Wiki for programmers who want to create mods
https://bitbucket.org/joaofarias/planetbase-modding/wiki/Home
Posted by: João Farias
https://bitbucket.org/joaofarias/planetbase-modding

 

6.3) cheat-mod code: (Cheat-Mode)
https://steamcommunity.com/sharedfiles/filedetails/?id=1983401261
Link to the source code: https://www.m-p-g-h.net/forum/showthread.php?t=1041129&p=11062099&viewfull=1#post11062099 (remove the "-" from the name of the site so that the name contains only a four-letter word).

 

6.4) Planetbase Custom code:
https://steamcommunity.com/app/403190/discussions/0/343788552531043105/
File can be downloaded here: a) http://goo.gl/LxR2jT

 

6.5) look at the code among the existing mods for the game.
Most mods are available on the site:
https://www.nexusmods.com/planetbase/mods/

 

7) Write directly a message to the authors of the mods.
There are very strong programmers there, but they now rarely read the forum.

 

8 ) Write a message directly to the authors of the game.
They can be found by name on social networks.
On the official website of the game indicated emails.

 

--------------

Collaboration:

 

You can create a dashboard in trello for collaboration and combine efforts with other fans of the game.
Example: Planetbase Modding in TRELLO https://trello.com/b/y9mEYjdS/planetbase-modding

 

 

--------------

Useful information about Mods:

 

An article with useful information about Mods:
https://www.nexusmods.com/planetbase/articles/9

You can read more about this in the following guides:

 

You can find out more about creating mods in Planetbase here:

1) Where to find ANSWERS and INFORMATION on Planetbase? https://steamcommunity.com/sharedfiles/filedetails/?id=1997926719

 

2) a lot of mods appeared https://www.nexusmods.com/planetbase/mods

 

3) Where to find and download mods?
In the game community, developers try to store all Planetbase mods on this resource: https://www.nexusmods.com/planetbase
Mod List - https://www.nexusmods.com/planetbase/mods/
List of mods by popularity - https://www.nexusmods.com/planetbase/mods/top
GUIDE: The list of mods: https://steamcommunity.com/sharedfiles/filedetails/?id=1981754832

 

___________

How to install mods?

 

For different engines (platforms) for mods, the options for installing mods will be different.
Later in this guide, we'll go over the different mod installation options for the two main mod engines (platforms for creating and working with mods).

In chronological order, we will first consider the option of installing mods on the JPFarias engine (2016), and then the option of installing mods on the Tahvohck engine (2020).

 

1 - How to install Mods? (for mods created on the JPFarias engine 2016):
[brief instruction]
1.1) make sure the game is patched and the Patcher is working. (On the main screen of the game, in the lower right corner, next to the version of the game, "[P]" will be written.
1.2) make sure Redirector is installed. (Not all mods need this requirement, but the vast majority).
1.3) download the required mod file.
1.4) unzip and place the mod file in "%UserProfile%/Documents/Planetbase/Mods".
1.5) that's all. Enjoy the game!

----------------------------------------------------------------
[Additional useful information]:
Patcher and all mods work fine for the GOG \ Steam \ Torrent \ ... versions of the game Planetbase 1.3.8. (And for all other versions of the game, all mods work well. The main thing is to install it correctly).

On the nexusmods website, two patchers are now available for playing Planetbase. One of them works, the second does not work.
Use the correct patcher, which was the very first and which still works great on all versions of the game Planetbase.

Here is the link to the correct patcher:
Planetbase Mod Patcher - https://www.nexusmods.com/planetbase/mods/1

You also need to use the correct Redirector.
Here is a link to the correct redirector suitable for the correct Patcher: https://www.nexusmods.com/planetbase/mods/3
______________________________________________

1 - How to install mods? (for mods created on the JPFarias engine 2016)
[More detailed instructions]

A) Instructions for installing mods - "Planetbase Mods to add to your game" - https://steamcommunity.com/app/403190/discussions/0/3182216552764118049/
(the text includes a list of mods from 2017, the list there is incomplete)

B) VIDEO-Installation Instructions for mods -
"Planetbase: How to Download Mods"

 

 

2 - How to install Mods? (for mods created on the Tahvohck engine 2020):
2.1) For mods created on the Tahvohck engine, no Patcher or Redirector is required. However, other software is required here.
2.2) Description from Tahvohck of his platform features and why he created it https://github.com/Tahvohck/Planetbase-Mods
2.3) Unity Mod Manager Configuration https://www.nexusmods.com/planetbase/mods/43
2.4) Planetbase Utilities https://www.nexusmods.com/planetbase/mods/45

 

--------------

Afterword

 

If you have information on how to supplement the manual, write in the comments.

Thank you for supporting the development of the Planetbase game community!

 

--------------

Helpful information:

 

Useful information on Planetbase in other guides:

 

1) Where to find ANSWERS and INFORMATION on Planetbase?
https://steamcommunity.com/sharedfiles/filedetails/?id=1997926719

 

2) All Steam Guides on Planetbase https://steamcommunity.com/app/403190/guides/

 

3) Guide, a collection of diagrams on the game Planetbase
https://steamcommunity.com/sharedfiles/filedetails/?id=1988280544

 

4) Creating Challenges https://steamcommunity.com/sharedfiles/filedetails/?id=677895200

 

5) [Rus] F.A.Q. Challenges https://steamcommunity.com/sharedfiles/filedetails/?id=1979452591

 

6) "PBCE Planetbase Challenge (Mission) Editor" program https://steamcommunity.com/sharedfiles/filedetails/?id=1991143520

 

7) The Art of Flattening Landscapes
https://steamcommunity.com/app/403190/discussions/0/1471969431589243652/

 

8 ) MODS
NexusMods - the largest platform for developers of mods for games
Blanetbase game page, all information https://www.nexusmods.com/planetbase
Planetbase MODS: https://www.nexusmods.com/planetbase/mods/
List of mods by popularity - https://www.nexusmods.com/planetbase/mods/top/

The list of mods and their description:
https://steamcommunity.com/sharedfiles/filedetails/?id=1981754832
F.A.Q. Mods, Cheats, Trainers for Planetbase
https://steamcommunity.com/sharedfiles/filedetails/?id=1981488180

 

9) Cheats and Trainers
https://steamcommunity.com/sharedfiles/filedetails/?id=1983103713

 

10) Create an island map for challenge

https://steamcommunity.com/sharedfiles/filedetails/?id=1987002995

 

11) VIDEOS
11.1) ALL VIDEOS on Planetbase. Walkthrough Challenges
https://steamcommunity.com/sharedfiles/filedetails/?id=1990024322
11.2) Video & Text Achievement Guides
https://steamcommunity.com/sharedfiles/filedetails/?id=2015075895

 

--------------

 

 

My other Planetbase guides:

 

Check out my other guides at the link below.
Here is a lot more useful information on Planetbase!

 

 

Join us if you also really like space games:

  • Group in Steam: Group: "Space Experience"
    This group contains the largest and most structured list of games and programs about space.
    Here you will find everything that exists to feel like in space, see space through VR, build a space colony, feel the harsh conditions for survival, control a rocket and repair it, arrange a battle in space, see 3D maps of planets and universes,
    and much, much other...
    https://steamcommunity.com/groups/SpaceExperience

 

 

--------------

--------------

--------------

Edited by NeoRider7
Link to comment
Share on other sites
  • 1 year later...
NeoRider7 Contributor

NeoRider7

Posted
  • Author
Posted (edited)

Self-contained mods \ Standalone \ Planetbase custom code: https://forums.nexusmods.com/index.php?/topic/10965873-self-contained-mods-standalone-planetbase-custom-code/

 

There are custom mods that are not described on the Nexusmods website.
Such mods were made for old versions of the game and they do not work with new versions of the game and with other mods.

Perhaps, when developing a new mod, it will be useful to look at the capabilities of such custom mods and their source code.

Some old standalone mods were able to do things that the mods currently featured on the Nexusmods site can't do.

Edited by NeoRider7
Link to comment
Share on other sites
  • 5 months later...
NeoRider7 Contributor

NeoRider7

Posted
  • Author
Posted

Is there a way to put new objects for this game?

 

- Answer:

Update 2022.06:

It turns out that there is a framework that allows you to add new buildings to the Planetbase game.

(Support for new buildings, characters, modules, ships, and anything else that uses a 3D model.)

This opportunity was created recently in 2022 and it's just fantastic!

Below I will list links where it is possible to read about it in more detail.

I can't wait until mods with new buildings appear on the basis of this framework!

1) Planetbase Framework compatibility mod for JPFarias-style mods released.

2) NexusMods: Planetbase Framework JPFarias compatibility layer.

3) GitHub: solidDoWant/Planetbase-Framework.

4) GitHub: (solidDoWant) Is it possible to create a mod that adds new buildings or items?

5) GitHub: (Tahvohck) Is it possible to create a mod that adds new buildings or items?

6) GitHub: solidDoWant/Planetbase-Compat-JPFarias.

Link to comment
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now
 Share
Go to topic listing

  • Recently Browsing   0 members

    • No registered users viewing this page.
×
×
  • Create New...