Types and history of frameworks for mods Planetbase.

About this image

1) Who this guide is for and why.

This guide will be useful to you if you want to use or create mods for the game Planetbase.

In the past, several different frameworks for mods were created for the game Planetbase.
Some of these frameworks and the mods for them still work today. Another part of the frameworks does not work anymore and is not used any more.
Or they work, but not with all possible versions of the game. 
In addition, the work of creating mods for Planetbase is associated with additional difficulties created by the modders of the authors of the game - the company "Madruga Works" and its leaders Martiño Figueroa and Tucho Fernández.

If you are new to the Planetbase community, or if you haven't followed the progress of the game since 2015, it may be helpful to read the following information to understand the situation with mods and frameworks.

2) Disclamer.   

• The information in this manual is current at the time of writing. As time goes on, there will probably be some changes and additions. 
• Many years have passed since the release of the game in 2015, and it is possible that I have forgotten something. 
  

If you have anything to add or clarify, please write it in the comments!

3) Brief history.

The game Planetbase was released in the year 2015. The first mods for the game were released in 2016.
A lot has happened in the community since then. As for mods, there have been about a hundred released.  (Some are now deleted).
Mods run and are created under several different frameworks.

At the time of writing this guide, there are now (2023-2024) mainly 3 types of frameworks for mods being used for the Planetbase game.
Previously, especially in the early years, there were even more kinds of frameworks for Planetbase mods. 
We will not go into the description of frameworks that have not been used for many years, but will focus more on the description of those types of frameworks that are actively used recently (2023-2024) and can be downloaded from the NexusMods website.


4) Why are there so many frameworks?

Unfortunately, there are now many different frameworks for Planetbase mods.
This is very confusing for new players and modders who have recently joined the community or who have been away for a few years.

Many modders are self-employed, develop their own frameworks and do not know what other modders have done or plan to do. 
This guide you are reading was written in part to address this problem.

The main reason for this situation is the actions of the game's authors, Madruga Works and its executives Martiño Figueroa and Tucho Fernández. 
All these years they have been ignoring the wishes and letters of the players, refusing to publish information about the frameworks and to cooperate with the modders, sometimes deleting posts from the Steam forum and banning the modders who simply asked about the possibilities of improving the game. 

More details about all this are given below the text.


5) Attitude of the authors of the game "Madruga Works" towards modders and mods.

The authors of the game, the company "Madruga Works" and its directors Martiño Figueroa and Tucho Fernández, have a very negative attitude towards modders and mods, as well as any messages and suggestions related to the improvement of the game. 
Over the years, the game's authors have completely ignored players' suggestions for improving the game in all resources where such suggestions are posted, including forums, reddit and e-mail.
In addition, Madruga Works and Martiño Figueroa in particular have been deleting the game's Steam forum posts and banning modders and the most active members of the game's community. 
For example, if you create a thread in the Steam forum dedicated to suggestions for improving the game and send questions to Martiño Figueroa, there is a high probability that Martiño Figueroa will delete this discussion thread and the participants of the correspondence will be permanently banned from the Steam forum.

The banning of modders by Madruga Works and the blocking of information on how to improve the game has resulted in the following:

a) Mods and players leaving for other games.
Significant decrease in all game stats, including daily player base and game sales stats.
Low game and mod popularity. At it's peak (release) the game had only 6000 concurrent players. Nowadays there are 150-300 concurrent players. 
For a game to have an active and vibrant modding community, it needs to reach a certain critical mass. 
If 10% of the players want to mod their game, and 10% of those people want to write mods, that comes out to 15-30 people using mods and 1.5-3 people writing mods.
In the current situation, there are simply not enough people willing to do the work to create content and quality mods with new textures, buildings, items, ships, technology, etc.

b) Poor modding community marketing.
Poor awareness of each other's actions by remaining and new modders.
The Planetbase community is not aware of mods, or think using them is too hard, is not aware of what offerings currently exist, etc. 
 
Planetbase modding in general needs more/better marketing to attract players to modding their game, and in turn attracting new mod creators. 
For the community to thrive we need to attract not just players who are looking to solve a specific problem (i.e. 'how do I make time warp faster?'), but players who are looking to solve a more general problem (i.e. 'how do I increase the replayability of this game?'). 

c) Creating multiple independent frameworks for mods. 

Below we will take a closer look at each type of framework with its features, pros and cons. 


6) The main known frameworks for Planetbase game mods.

6.1) Framework #1: Author JPFarias (João Farias). 

Date of creation: (Mar 24, 2016).       It's been 8 years!
Patcher-1 and Redirector-1 must be installed for the mods to work.
This is the very first Framework-1 for Planetbase game mods.     

Credits: 

• João Farias is the creator of Framework-1, the first mods for the game and the project manager of the mod series in 2016.
• In order to create the first mods on Framework-1, fans of the game realized a special joint project on which about two dozen modders worked simultaneously.
• You can see the details of this joint project to create the first mods, for example, here in Trello. 
• The source code of Framework-1, Patcher-1, Redirector-1 and the first mods is available on BitBucket.org 
• PiMaker for the original version of the Mod Patcher-1 that can be found here.  
• SSchoener for the detour mechanism used in the Redirector-1 - it can be found here.  
  

Useful information and guides related to Framework-1 and mods for it:

• Wiki about Framework-1, using and creating the first mods (2016) posted on BitBucket.org 
• "Main PROBLEMS OF INSTALLING MODS". 
• Instructions for installing mods - "Planetbase Mods to add to your game". (the text contains a list of mods from 2017, the list there is incomplete).
• VIDEO-Installation guide for mods - "Planetbase: How to Download Mods".
• "F.A.Q. Mods, Cheats, Trainers for Planetbase".
• The list of mods can be found at NexusMods and in this guide "List of Mods".
  

Pros of Framework #1:

• The most popular and widely used framework for Planetbase game mods among players. From 2016 until now.
• The largest number of players download and use mods on this particular Framework-1. (Mostly out of habit and lack of awareness of the existence of other frameworks).
• The very first framework published on NexusMods (2016). 
• The largest number of mods written for this Framework-1. (At the time of writing this guide).
• There are instructions, FAQs and video tutorials on how to install  Framework-1. 
• Mods written on this Framework-1 may work on some other frameworks. For example, Framework-2.
• Framework-1 and its mods work on all versions of Planetbase.
  

Cons of Framework #1: 

• You can't do some things and complex mods on this Framework-1. 
  For example, you can't change textures, buildings, items, ships, technology, etc. like in Framework-2 by solidDoWant.
• João Farias was a major contributor to the planetbase modding community back in 2016, writing both the original Patcher-1 and a plethora of mods. 
  Although their mods were impressive, they used the hacky Redirector-1 mod to overwrite base game methods, and the very hacky Patcher-1 to inject at all. 
  Since then HarmonyLib has come around and offered much more elegant ways to patch methods, and Unity Mod Manager UMM (Framework-4) has given us a more robust modloader.

6.2) Framework #2: Author solidDoWant.    

Creation date:  2017. 
Original upload GitHub:  9 Jan 2017.    Original upload NexusMods: 10 June 2019.
For mods to work, you need to install: "Planetbase Mod Patcher 2".
Add-on for this framework: "Planetbase Framework JPFarias compatibility layer" (2022).
With this add-on for Framework-2, all previously released mods for Framework-1 by JPFarias will continue to work.

This is the second Framework-2 for Planetbase game mods to appear on NexusMods resources.   

Credits: 

• solidDoWant - creator of the Framework-2. 
• A full list of people who helped create Framework-2 is listed here.
  

Useful information and Guides related to Framework-2 and mods for it:

• Planetbase-Framework-2 wiki.
• "Installing the Framework-2".
• "Creating new mods".
• Discord created by solidDoWant where it is possible to discuss all questions and suggestions related to Framework-2. 
  

Pros of Framework #2: 

• This is an updated version of the original mod Patcher-1 by jpfarias. This is designed to provide a large number of additional feature to modders, as well as make the modded game faster much more stable overall.
•  It is possible to create new textures, buildings, items, ships, technology, and more. 
  At the time of writing, other frameworks are not able to provide such a wide range of functionality and features for mods.
• Mods that were previously created on Framework-1will continue to work on Framework-2.
• Online support is available from the author of Framework-2 (solidDoWant): Discord, Issue, Steam. 
• Framework-2 and mods for it will work for any version of the game Planetbase.
  

Cons of Framework #2:

• No video tutorial on how to install Framework-2.
• Slightly less popular among players than Framework-1 due to the lack of advertising support anywhere. Including the refusal of the authors of the game "Madruga Works" to cooperate. (But they refuse like all modders and frameworks all these years).
  

6.3) Framework #3: "Unity Mod Manager Configuration" (UMMC). Author: Tahvohck.

Creation date: 2020.
For mods to work, you need to install: "Unity Mod Manager Configuration"(UMMC) + "Planetbase Utilities".
To install mods, you need to use Unity Mod Manager (UMM, Framework #4), but to be able to install them, you need to run the Unity Mod Manager Configuration (Framework #3), on PowerShell. 

This is the third Framework-3 for Planetbase game mods that appeared on NexusMods resources.

This Framework-3 was created before Framework #4 "Unity Mod Manager" (UMM) had built-in support for the Planetbase game  (2023).
Later (after about 2022), there was no need for Framework-3 ("Unity Mod Manager Configuration"), as UMM (Framework-4) began to support the game on its own.

Pros of Framework #3: 

• One of the goals of this project is to eliminate the need for Patcher-1 and Redirector-1, which are required for Framework-1 to work.
• João Farias was a major contributor to the planetbase modding community back in 2016, writing both the original Patcher-1 and a plethora of mods. 
  Although their mods were impressive, they used the hacky Redirector-1 mod to overwrite base game methods, and the very hacky Patcher-1 to inject at all.  Since then HarmonyLib has come around and offered much more elegant ways to patch methods, and Unity Mod Manager UMM (Framework-4) has given us a more robust modloader.

Cons of Framework #3:

• This Framework-3 does not work at the moment. 
• Simply put, this Framework-3 was a temporary solution (2020-2021) for people who wanted to use Framework-4 ("Unity Mod Manager"), while Framework-4 ("Unity Mod Manager") was not yet able to support the Planetbase game on its own. 
• There are no tutorials (text or video) on how to install Framework-3. It is extremely difficult for ordinary players to understand how to use Framework-3.
• Extremely low usage by players due to: a) limited lifespan of this Framework-3 and the time it was needed. b) lack of sufficient support, promotion, tutorials and documentation.
• Mods created for Framework-3 will not work for Framework-1 and Framework-2.  
• You can't do some things and complex mods on this Framework-3.
  For example, you can't change textures, buildings, items, ships, technology, etc. like in Framework-2 by solidDoWant.

Perhaps the development and improvement of Framework-3 will become relevant again, as Framework-4 ("Unity Mod Manager") is currently down again for the latest version of the Planetbase game (v.1.4.0).


6.4) Framework #4:  "Unity Mod Manager" = UMM.    
Author: newman55 (GitHub, NexusMods).  
Creation date: Original upload: August 29, 2018
Date when the Planetbase game was first supported in Framework-4 (UMM): approximately 2022-2023.
Support for Planetbase game version 1.4.0: Not running (as of this writing).

Mods and Framework-4 are required for the mods to work: 
Quick installation guide: 

• Install the Framework-4 "Unity Mod Manager". 
• install last ".Net Framework 4+".
• Enter path to the game.
• Select install command and installation method. 
  
  

This Framework-4 (UMM) is not available on "NexusMods/Planetbase" resources because this Framework-4 (UMM) is developed for a large number of games based on the Unity engine. 

Useful information and guides related to Framework-4 (Unity Mod Manager) and mods for it:

• NexusMods. 
• GitHub  
• Video: How to Install UMM? - Dropbox, YouTube 
• Wiki 
• Source code 
• Nuget 
• RuntimeUnityEditor 
  

Pros of Framework #4: 

• Framework-4 (UMM) i may be familiar to some players and modders from other games, as it is a universal framework created for dozens of different games based on the Unity engine. 
  

Cons of Framework #4:

• This Framework-4 (UMM) does not currently work with the Planetbase 1.4.0 version of the game (at the time of this writing).
• You can't do some things and complex mods on this Framework-4 (UMM).
  For example, you can't change textures, buildings, items, ships, technology, etc. like in Framework-2 by solidDoWant.
• This is the latest Framework-4 (UMM) for the Planetbase game. Many players have long been accustomed to using other powerful frameworks.
• Extremely low usage by players due to: a) the recent and limited life of this framework. b) lack of sufficient promotion, support and information in the Planetbase community.
• Mods created for Framework-4 (UMM) will not work for the more popular Frameworks in the Planetbase community: Framework-1 and Framework-2.  
• There is currently no tutorial (video or text) on how to make Framework-4 (UMM)  and mods work specifically for the Planetbase game.
  Because of this, many players who do not have special experience and programming skills are not able to understand how to use this Framework-4 (UMM).

7) Old frameworks for Planetbase mods.
Over the years since the release of Planetbase, fans of the game have created many projects using frameworks and trying to improve them.
Many of these projects no longer exist on the Internet. They are not on the NexusMods website.
I will write some information about these projects below. But for sure I might have missed someone, forgotten about them for so many years, or just not found relevant information. 

7.1) PiMaker
7.2) Melon Loader

If you know of other projects related to Frameworks and attempts to improve the Planetbase game, please let us know in the comments.

8) Options for further development of frameworks, mods and the whole Planetbase game.

8.1) Interaction with Madruga Works game authors.
If Madruga Works (and its executives Martiño Figueroa and Tucho Fernández) wanted to work with modders, it could benefit both the player community and Madruga Works.
For years, players have tried to talk to Madruga Works management about this. At best, Madruga Works ignores all such issues. At times, Martiño Figueroa bans player and modders and deletes Steam forum posts on the topic of game development suggestions.
In this respect, the prospects of participation of the game's authors in its development and the development of frameworks and mods are very unlikely. 
 
8.2) Most likely scenario.
(IMHO, this is just my point of view. You can describe your point of view in the comments below).
Since the authors of the game "Madruga Works" do not develop the game themselves, and counteract the support of modders, the game is gradually forgotten by the players.
A large number of modders, seeing the bans and unfriendly attitude towards them, go to projects to create mods for other games.
Those modders who try to do something here do not stay for a long time and leave the community because it is too difficult/confusing to handle. 

In the end, thanks to its creators Madruga Works, the game Planetbase is dead and abandoned much sooner than it could have been. 
This happens despite the tremendous support of the community in the first years after the game's release.

8.3) Positive scenario.
Regarding frameworks situations:  
IMHO, there should be a common platform that supports mods from other patchers/frameworks.
It should not be another new framework, but rather a modification of an existing one.   
For example, Framework-2 by solidDoWant can also support mods for Framework-1 by JPFarias.

Also, the final common platform should support all the best developments for creating complex functional mods that exist in the individual frameworks.
For example, mods created on Framework-2 by solidDoWant will be able to add and modify textures, buildings, items, ships, technology, and more.
At the time of writing, other frameworks are not able to provide such a wide range of functionality and features for mods. 

9) A list of useful information about the game.

Since new players join Planetbase on a regular basis, and not everyone has had time to follow the game since its release in 2015, we list some useful information about the game below: 

• Where to find ANSWERS and INFORMATION about Planetbase?.
• A directory of useful links to information about the game.
• Creating Maps and Challenges in the PBCE Planetbase Challenge (Mission) Editor.
• F.A.Q. Challenges. List of useful links about Challenges.
• List of Mods.  Mod List.
• If you have questions about creating a MOD.
• Is it possible to create a mod that adds new buildings or items?
• Modding Progress With PlanetbaseFramework.
• Is This Game Still Alive for Further Mods?
• Reddit. 
• Discord.
  

And get some bonus information:

• Big LIST OF GAMES similar to the game "Planetbase": "Space Colonization & Survival Games".
• Group SpaceExperience in Steam.
• Curator SpaceExperience of games about space in Steam.
  

10) Feedback.
Use the comments section to share your feedback on the game, its frameworks and mods.
Which mod framework do you use and why?
Also, it would be great if you could tell us about your Planetbase experience, ideas for improvements and new mods!

You can do this both in the comments below and on other independent resources dedicated to the game Planetbase.
For example, on Discord, Reddit, NexusMods. 

Writing feedback and suggestions on the official resources of the game is not recommended, 
because there is a great risk that the authors of the game (the company "Madruga Works" and its managers Martiño Figueroa and Tucho Fernández) will delete such a post and the author of the post will be banned.
However, "Madruga Works" cannot ban your game reviews, guides, collections, screenshots and images in Steam.

11) Conclusion.                 
I would like to express my gratitude to all modders and active participants of the Planetbase game community!
It is thanks to you that, despite the inaction or sometimes even despicable actions of the authors of the game "Madruga Works", the game, frameworks and mods continue to develop and delight players with new content and experiences!

And personally, I have been honored and very happy to be friends with you and to work together on the mods and frameworks, all these long years!
Thanks to everyone involved!

We continue our flight to new horizons!

SEE YOU SPACE COWBOY...