Skip to content

Commit 9a0ca15

Browse files
committed
Update docs guides and FAQ
1 parent 4f7abba commit 9a0ca15

9 files changed

Lines changed: 215 additions & 132 deletions

File tree

astro.config.mjs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,10 @@ export default defineConfig({
4949
{
5050
label: 'Modding Documentation',
5151
link: 'https://modding.ksp2redux.org',
52+
},
53+
{
54+
label: 'API Reference',
55+
link: 'https://api.ksp2redux.org',
5256
}
5357
],
5458
expressiveCode: {
Lines changed: 84 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,60 @@
11
---
22
title: Contributing to Redux
3-
description: Learn how you can contribute to KSP2 Redux as an artist, developer, translator, or player.
3+
description: Learn how you can contribute to KSP2 Redux as a 3D artist, developer, translator, designer, video editor, modder, or player.
44
---
55

66
import { Aside, Card, CardGrid } from '@astrojs/starlight/components';
77

8-
We are always looking for contributors to help us bring KSP2 Redux to life! Whether you're an artist, developer, translator, or player, there are many ways to get involved.
8+
We are always looking for contributors to help us bring KSP2 Redux to life! Whether you're a 3D artist, developer, translator, designer, video editor, modder, or player, there are many ways to get involved.
99

1010
## Ways to Contribute
1111

1212
<CardGrid>
13-
<Card title="🎨 Artists">
14-
Create 3D models, textures, celestial bodies, and visual assets for the game.
13+
<Card title="🎨 3D Artists">
14+
Create 3D models, textures, celestial bodies, and visual assets for the game. [Go to section →](#for-3d-artists)
1515
</Card>
1616

1717
<Card title="💻 Developers">
18-
Help build features, fix bugs, and improve performance with C# and Unity.
18+
Help build features, fix bugs, and improve performance with C# and Unity. [Go to section →](#for-developers)
1919
</Card>
2020

2121
<Card title="🌍 Translators">
22-
Translate game content into French, German, Italian, Spanish, Japanese, Korean, Polish, Russian, Portuguese, and Chinese.
22+
Translate game content into French, German, Italian, Spanish, Japanese, Korean, Polish, Russian, Portuguese, and Chinese. [Go to section →](#for-translators)
23+
</Card>
24+
25+
<Card title="🎬 Design & Media">
26+
Create graphics, animations, videos, web design, and other community-facing material. [Go to section →](#for-design-animation-and-video)
27+
</Card>
28+
29+
<Card title="🧩 Modders">
30+
Port existing mods or build new Redux-native mods. [Go to section →](#for-modders)
2331
</Card>
2432

2533
<Card title="🎮 Players">
26-
Test beta builds, report bugs, and provide feedback on features and gameplay.
34+
Test beta builds, report bugs, and provide feedback on features and gameplay. [Go to section →](#for-players)
2735
</Card>
2836
</CardGrid>
2937

3038
---
3139

32-
## For Artists
40+
## For 3D Artists
3341

3442
We are reaching a point in development where we need to start working on a lot of 3D models, textures, celestial bodies, and other visual content.
3543

3644
### What We Need
3745

38-
- **Part Models:** Colony parts, orbital structures, interstellar engines
39-
- **Textures:** High-quality PBR textures for parts and environments
46+
- **Part Models:** New vessel parts, colony parts, orbital structures, and interstellar engines
47+
- **Textures:** High-quality PBR textures for parts and environments
4048
- **Celestial Bodies:** Planets and moons for the Debdeb star system
41-
- **UI Assets:** Icons, interfaces, and visual effects
42-
- **Animations:** Part animations, Kerbal animations
49+
- **Asset Pipeline:** Helping define art guidelines and asset workflows for future Redux content
4350

4451
### Skills We're Looking For
4552

4653
- 3D modeling (Blender, Maya, 3ds Max)
4754
- Texturing and materials (Substance Painter, Photoshop)
4855
- Unity experience (preferred but not required)
4956
- Understanding of game asset optimization
57+
- Experience building assets for real-time games
5058

5159
### Getting Started
5260

@@ -55,12 +63,29 @@ If you are an artist with experience in these areas, we would greatly appreciate
5563
</Aside>
5664

5765
**Contact our Art Lead:**
58-
- Join the [KSP2 Modding Society Discord](https://discord.gg/ksp2redux)
66+
- Join the [KSP2 Redux Discord](https://discord.gg/ksp2redux)
5967
- Go to the **#🟡redux-chat** channel
6068
- DM **@safarte** with examples of your work
6169

6270
---
6371

72+
## For Design, Animation, and Video
73+
74+
Redux also needs help with visual material outside of 3D game assets.
75+
76+
### What We Need
77+
78+
- **2D Art and Animation:** In-game tutorial videos, mission animations, concept art, and possible promotional material
79+
- **Graphic and Web Design:** Website improvements, graphics for dev updates, social posts, infographics, and other community-facing visuals
80+
- **Video Editing:** Feature highlight videos, showcase videos, and short update clips
81+
- **Writing and Editing:** Clear docs, dev-update text, and other public-facing material
82+
83+
### Getting Started
84+
85+
Send **@.munix** or **@safarte** examples of your previous work on Discord. Useful examples include screenshots, renders, animation reels, design work, videos, writing samples, or links to a portfolio.
86+
87+
---
88+
6489
## For Developers
6590

6691
In order to achieve the goals in our roadmap, we are looking for active volunteer developers interested in joining the team!
@@ -70,7 +95,7 @@ In order to achieve the goals in our roadmap, we are looking for active voluntee
7095
Ideally, we're looking for applicants with experience in one or more of the following:
7196

7297
- **KSP1/KSP2 Mod Development:** Familiarity with the game's systems and modding
73-
- **Graphics Programming:** HLSL, Unity Shader Graph, ShaderLab
98+
- **Graphics Programming and Technical Art:** HLSL, Unity Shader Graph, ShaderLab, URP, rendering, lighting, and post-processing
7499
- **Unity Development:** C# scripting, ECS/DOTS, game systems
75100
- **C# Programming:** Strong C# fundamentals and best practices
76101

@@ -79,7 +104,7 @@ Ideally, we're looking for applicants with experience in one or more of the foll
79104
Depending on your skills and interests:
80105
- Performance optimizations (ECS, DOTS, profiling)
81106
- Core game systems (colonies, resources, multiplayer)
82-
- Graphics improvements (shaders, effects, rendering)
107+
- Graphics improvements, including the Built-in Render Pipeline to URP port, shaders, reentry VFX, engine plumes, rendering, lighting, and post-processing
83108
- Modding SDK and tools
84109
- Bug fixes and quality improvements
85110

@@ -94,6 +119,7 @@ We require proof of experience before joining the development team to ensure con
94119
- Links to mods you've created
95120
- Information about games you've worked on
96121
- Any other relevant experience
122+
- Proof that you own KSP2
97123

98124
This helps us understand your skills and find the right area for you to contribute.
99125

@@ -105,19 +131,16 @@ If you are comfortable in English, fluent in one of the languages listed below,
105131

106132
### Languages We Need
107133

108-
We are looking for translators for:
134+
We are especially looking for translators for:
109135

110-
- French
111-
- German
136+
- Chinese (Traditional)
112137
- Italian
113-
- Spanish
114138
- Japanese
115139
- Korean
116-
- Polish
117-
- Russian
118140
- Portuguese (Brazil)
119-
- Chinese (Simplified)
120-
- Chinese (Traditional)
141+
- Spanish
142+
143+
Other languages may still be useful, including French, German, Polish, Russian, and Chinese (Simplified).
121144

122145
### What You'll Translate
123146

@@ -130,11 +153,40 @@ We are looking for translators for:
130153
### Getting Started
131154

132155
**Contact our Translation Coordinator:**
133-
- Join the [KSP2 Modding Society Discord](https://discord.gg/ksp2redux)
156+
- Join the [KSP2 Redux Discord](https://discord.gg/ksp2redux)
134157
- DM **@safarte** mentioning which language(s) you can translate
135158

136159
---
137160

161+
## For Modders
162+
163+
### Updating Existing Mods
164+
165+
If you maintain KSP2 mods, we want to help you migrate them to Redux!
166+
167+
**What's Changed:**
168+
- Transition from BepInEx to integrated mod loader
169+
- Improved modding API with new endpoints
170+
- Core systems rewritten (e.g., TransformFrame)
171+
- Unity Editor integration for development
172+
173+
**Get Migration Help:**
174+
- Join **#🔴mod-dev** on [Discord](https://discord.gg/ksp2redux)
175+
- Read the [modding documentation](https://modding.ksp2redux.org)
176+
- Check the [Redux API documentation](https://api.ksp2redux.org)
177+
178+
### Creating New Mods
179+
180+
Redux mods use the integrated mod loader, the Redux modding SDK, and the current Redux API. The workflow is different from stock KSP2 BepInEx mods, so start with the current docs before setting up a new project.
181+
182+
- **Modding Docs:** [modding.ksp2redux.org](https://modding.ksp2redux.org)
183+
- **API Reference:** [api.ksp2redux.org](https://api.ksp2redux.org)
184+
- **Development Help:** Ask in **#🔴mod-dev** on [Discord](https://discord.gg/ksp2redux)
185+
186+
Learn more in our [Modding SDK blog post](/blog/modding-tools-unity-editor).
187+
188+
---
189+
138190
## For Players
139191

140192
Even if you're not creating content, there are still important ways you can help!
@@ -183,72 +235,25 @@ Have ideas for improvements? We want to hear them!
183235

184236
---
185237

186-
## For Modders
187-
188-
### Updating Existing Mods
189-
190-
If you maintain KSP2 mods, we want to help you migrate them to Redux!
191-
192-
**What's Changed:**
193-
- Transition from BepInEx to integrated mod loader
194-
- Improved modding API with new endpoints
195-
- Core systems rewritten (e.g., TransformFrame)
196-
- Unity Editor integration for development
197-
198-
**Get Migration Help:**
199-
- Join **#🟡redux-chat** on [Discord](https://discord.gg/ksp2redux)
200-
- DM **@safarte** for guidance on updating your mods
201-
- Access upcoming modding documentation
202-
203-
### Creating New Mods
204-
205-
The Redux Modding SDK offers revolutionary improvements:
206-
207-
- **Unity Editor Integration:** Test mods directly in Unity Play mode
208-
- **Rapid Iteration:** See changes in seconds, not minutes
209-
- **Better Debugging:** Full Unity debugging tools
210-
- **Improved APIs:** More comprehensive modding endpoints
211-
212-
Learn more in our [Modding SDK blog post](/blog/modding-tools-unity-editor).
213-
214-
---
215-
216-
## General Guidelines
217-
218-
### Communication
219-
220-
- **Discord:** Primary hub for discussions and coordination
221-
- **GitHub:** Code contributions, issues, and releases
222-
- **Forum:** Long-form discussions and announcements
223-
224-
### Be Respectful
225-
226-
- This is a volunteer project - everyone is contributing their free time
227-
- Be patient with each other
228-
- Constructive criticism is welcome, but stay civil
229-
- Remember we're all here because we love KSP2
230-
231-
### Quality Standards
238+
## Contact & Getting Started
232239

233-
- Test your contributions thoroughly
234-
- Follow existing code/asset conventions
235-
- Ask questions if you're unsure about something
236-
- It's okay to make mistakes - we'll help you learn!
240+
The best way to get involved is through our Discord server:
237241

238-
---
242+
**[Join the KSP2 Redux Discord →](https://discord.gg/ksp2redux)**
239243

240-
## Contact & Getting Started
244+
You do not need to be available all the time. Redux is a volunteer project, so clear communication and genuine interest in the project matter more than constant availability.
241245

242-
The best way to get involved is through our Discord server:
246+
When you reach out, include a few references depending on what you want to help with. Examples include GitHub repositories, mod pages, code samples, screenshots or renders of 3D models, shader work, animations, design work, videos, writing samples, or a portfolio. You do not need to provide references for translation, but previous translation or writing experience is useful to mention.
243247

244-
**[Join the KSP2 Modding Society Discord →](https://discord.gg/ksp2redux)**
248+
We cannot promise that every person who reaches out will immediately have something assigned, but if you have relevant experience and want to help finish what KSP2 started, please contact us.
245249

246250
### Key Channels
247251

248252
- **#🟡redux-news:** News about KSP2 Redux
249253
- **#🟡redux-dev-tracker:** Important messages by Redux devs
250254
- **#🟡redux-resources:** Links to important Redux & modding resources
251255
- **#🟡redux-chat:** General Redux discussion
256+
- **#🔴mod-dev:** Mod development help
252257
- **#🟡redux-bugs:** Bug reports
253258
- **#🟡redux-suggestions:** Feature suggestions and ideas
254259

@@ -261,4 +266,4 @@ The best way to get involved is through our Discord server:
261266

262267
## Thank You!
263268

264-
Redux is possible because of passionate community members like you. Every contribution, whether it's a bug report, a 3D model, a line of code, or a translation, helps make KSP2 Redux better for everyone.
269+
Redux is possible because of passionate community members like you. Every contribution, whether it's a bug report, a 3D model, a line of code, or a translation, helps make KSP2 Redux better for everyone.
Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
---
2+
title: Frontier and Exploration Modes
3+
description: How the planned Frontier and Exploration modes differ, especially around colonies, resources, and logistics.
4+
---
5+
6+
import { Aside } from '@astrojs/starlight/components';
7+
8+
<Aside type="caution" title="Planned Systems">
9+
Exploration mode colony resource rules are planned first. Frontier mode is planned for later. Details may change as the colony and resource systems are built.
10+
</Aside>
11+
12+
Redux plans to support two progression modes with different levels of resource management. Exploration mode is planned to arrive before Frontier mode.
13+
14+
**Exploration mode** is the lighter progression path. It keeps the focus on missions, science, discovery, and unlocking new capabilities. Resources still matter, but mostly as unlock requirements.
15+
16+
**Frontier mode** is the deeper resource-management path. It treats parts, colonies, fuels, and building materials as things that must be produced, stored, moved, and spent.
17+
18+
You can think of them as rough successors to KSP1's Science and Career modes:
19+
20+
| Mode | Closest KSP1 comparison | Main focus |
21+
| --- | --- | --- |
22+
| Exploration | Science | Explore, run experiments, complete missions, unlock resources and parts |
23+
| Frontier | Career | Build an economy of colonies, factories, stockpiles, and supply routes |
24+
25+
## Quick Comparison
26+
27+
| Question | Exploration mode | Frontier mode |
28+
| --- | --- | --- |
29+
| Do parts consume materials when built? | No. A part can be built once its required resources are unlocked. | Yes. Parts cost materials and fuels that must be available. |
30+
| Do resource amounts and production rates matter? | Mostly no. Resource access is treated as an unlock. | Yes. Mining, processing, stockpiles, and flow rates are central. |
31+
| What are colonies for? | Unlocking and sharing resource access across the colony network. | Producing materials, fuels, colony parts, and vessels. |
32+
| Are supply routes required? | No. The goal is to avoid routine logistics management. | Yes, planned supply routes are a major part of connecting colonies. |
33+
| Who is it for? | Players who want colonies to support exploration without heavy economy management. | Players who want colony placement, production chains, and logistics to matter. |
34+
35+
## Exploration Mode
36+
37+
Exploration mode uses resources as a progression and exploration system.
38+
39+
Instead of continuously mining and spending resource quantities, you unlock access to a resource at a colony. The unlock might require a specific colony facility, a mission, a science experiment, a location, or some other requirement.
40+
41+
Once the requirement is met, that resource is considered available for that colony. If a vessel or colony part requires that resource, you can build it there without tracking stockpile amounts or production rates.
42+
43+
### Orbital Colonies in Exploration
44+
45+
Orbital colonies are planned to act as resource links between celestial bodies.
46+
47+
If two celestial bodies both have an active orbital colony, their unlocked resources can be shared through that network. For example, if Duna and Kerbin both have orbital colonies, resources unlocked around Duna can become available to colonies connected through Kerbin's orbital network, and the other way around.
48+
49+
The intent is to make orbital colonies useful without asking every player to manage cargo routes and storage limits.
50+
51+
## Frontier Mode
52+
53+
Frontier mode uses resources as a production and logistics system.
54+
55+
In this mode, vessel and colony parts cost materials. To build those parts, you need the required materials available where the construction is happening. Those materials come from raw resources gathered by mining facilities and processed by factories.
56+
57+
Production can depend on things like local resource density, colony conditions, power, heat, or other balancing factors. The exact list is not final.
58+
59+
KSC is planned to provide unlimited access to basic building resources and common fuels, so the early game does not start with a logistics bottleneck. More advanced parts, colony growth, and exotic resources are expected to require off-world colonies.
60+
61+
### Colonies in Frontier
62+
63+
Frontier colonies are production hubs.
64+
65+
To found or grow a new colony, you may need to move resources, materials, or construction hardware from Kerbin or another colony. Once a colony is established, it can mine local resources, process them into useful materials, produce fuel, and eventually support local vessel or colony construction.
66+
67+
Later in the roadmap, supply routes are planned to reduce repeated manual cargo flights. A successful delivery from one colony to another could be recorded as a recurring route that transfers resources over time.
68+
69+
## What Both Modes Share
70+
71+
Both modes are planned to use colonies, resources, missions, science, and tech progression. The difference is not whether resources exist. The difference is how much resource bookkeeping the player is asked to do.
72+
73+
In Exploration mode, resources answer the question: **Have you discovered and unlocked what this part needs?**
74+
75+
In Frontier mode, resources answer the question: **Can your colony network produce, store, and deliver what this part costs?**
76+
77+
## Current Status
78+
79+
Redux is currently in **Stage 0: Foundation**. The public beta work is still focused on performance, bug fixes, UI cleanup, modding tools, heat, vessel ISRU groundwork, and tech tree requirements.
80+
81+
Exploration mode colony resource rules are planned before Frontier mode. Colonies, full resource networks, and both progression-mode updates are still later roadmap work.

src/content/docs/guides/index.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@ Use this page if you are installing Redux, checking compatibility, looking for t
2727
<Card title="Roadmap" icon="star">
2828
Check the current stage, completed work, and later milestones. [Open roadmap →](/roadmap/)
2929
</Card>
30+
<Card title="Frontier and Exploration Modes" icon="rocket">
31+
Understand how the planned progression modes handle resources, colonies, and supply routes. [Read guide →](/guides/frontier-and-exploration/)
32+
</Card>
3033
<Card title="Implemented Features and Fixes" icon="check-circle">
3134
Read about the features, improvements, and bug fixes in Redux. [Open summary →](/guides/implemented-features-and-fixes/)
3235
</Card>
@@ -56,6 +59,7 @@ These posts are a reasonable starting point if you want more context about the p
5659
- [Debug Tools Updates](/blog/debug-tools-update/) - Debug windows and utility work
5760
- [Modding SDK: Unity Editor Integration](/blog/modding-tools-unity-editor/) - Current direction for Redux modding
5861
- [Resource Scanning System](/blog/resource-scanning-wip/) - Early work related to later roadmap systems
62+
- [Frontier and Exploration Modes](/guides/frontier-and-exploration/) - Planned resource and colony progression rules
5963

6064
[View all blog posts →](/blog/)
6165

0 commit comments

Comments
 (0)