Skip to content

Commit

Permalink
Direct readme to new docs. New hero image
Browse files Browse the repository at this point in the history
  • Loading branch information
TokisanGames committed Nov 30, 2023
1 parent 2f01c79 commit 4c752bd
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 49 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

We need your help to make this the best terrain plugin for Godot.

Please see [System Design](https://github.com/TokisanGames/Terrain3D/wiki/System-Design) to gain an understanding of how the system works. Then review the [roadmap](https://github.com/users/TokisanGames/projects/3) for priority of issues.
Please see [System Architecture](https://terrain3d.readthedocs.io/en/latest/docs/system_architecture.html) to gain an understanding of how the system works. Then review the [roadmap](https://github.com/users/TokisanGames/projects/3) for priority of issues.

If you wish to take on a major component, it's best to join our discord and discuss your plans with Cory to make sure your efforts are aligned to other plans.

## Setup Your System

Make sure you are setup to [build the plugin from source](https://github.com/TokisanGames/Terrain3D/wiki/Building-From-Source).
Make sure you are setup to [build the plugin from source](https://terrain3d.readthedocs.io/en/latest/docs/building_from_source.html).

## PR Workflow

Expand Down
37 changes: 6 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,46 +6,21 @@ A high performance, editable terrain system for Godot 4, written in C++.
## Features
* Written in C++ as a GDExtension plugin, which works with official engine builds
* Can be accessed by GDScript, C#, and any language Godot supports
* Geometric Clipmap Mesh Terrain, as used in The Witcher 3. See [System Design](https://github.com/TokisanGames/Terrain3D/wiki/System-Design)
* Geometric Clipmap Mesh Terrain, as used in The Witcher 3. See [System Architecture](https://terrain3d.readthedocs.io/en/latest/docs/system_architecture.html)
* Up to 16k x 16k in 1k regions (imagine multiple islands without paying for 16k^2 vram)
* Up to 10 Levels of Detail (LODs)
* Up to 32 texture sets using albedo, normal, roughness, height
* Sculpting, texture painting, texture detiling, painting colors and wetness, undo/redo
* Supports importing heightmaps from [HTerrain](https://github.com/Zylann/godot_heightmap_plugin/), WorldMachine, Unity, Unreal and any tool that can export a heightmap (raw/r16/exr/+). See [importing](https://github.com/TokisanGames/Terrain3D/wiki/Importing-&-Exporting-Data)
* Supports importing heightmaps from [HTerrain](https://github.com/Zylann/godot_heightmap_plugin/), WorldMachine, Unity, Unreal and any tool that can export a heightmap (raw/r16/exr/+). See [importing data](https://terrain3d.readthedocs.io/en/latest/docs/import_export.html)

See the [Wiki](https://github.com/TokisanGames/Terrain3D/wiki) for project status, design, and usage.
See [Project Status](https://terrain3d.readthedocs.io/en/latest/docs/project_status.html) for details.

## Requirements
* Supports Godot 4.1+. [4.0 is possible](https://github.com/TokisanGames/Terrain3D/wiki/Using-Previous-Engine-Versions).
* Supports Windows, Linux, and macOS. Other platforms pending.
## Getting Started

## Installation & Setup
Read all of the documentation in the Getting Started section in the documentation, beginning with [Installation](https://terrain3d.readthedocs.io/en/latest/docs/installation.html).

### Run the demo
1. Download the [latest release](https://github.com/TokisanGames/Terrain3D/releases) and extract the files, or [build the plugin from source](https://github.com/TokisanGames/Terrain3D/wiki/Building-From-Source).
2. Run Godot, using the console executable so you can see error messages.
3. In the project manager, import the demo project and open it. Allow Godot to restart.
4. In `Project Settings / Plugins`, ensure that Terrain3D is enabled.
5. Select `Project / Reload Current Project` to restart once more.
6. If the demo scene doesn't open automatically, open `demo/Demo.tscn`. You should see a terrain. Run the scene.
[Getting Help](https://terrain3d.readthedocs.io/en/latest/docs/getting_help.html) or join our [Discord server](https://tokisan.com/discord).

### Install Terrain3D in your own project
1. Download the [latest release](https://github.com/TokisanGames/Terrain3D/releases) and extract the files, or [build the plugin from source](https://github.com/TokisanGames/Terrain3D/wiki/Building-From-Source).
2. Copy `addons/terrain_3d` to your project folder as `addons/terrain_3d`.
3. Run Godot, using the console executable so you can see error messages. Restart when it prompts.
6. In `Project Settings / Plugins`, ensure that Terrain3D is enabled.
7. Select `Project / Reload Current Project` to restart once more.
8. Create or open a 3D scene and add a new Terrain3D node.
9. Select Terrain3D in the Scene panel. In the Inspector, click the down arrow to the right of the `storage` resource and save it as a binary `.res` file. The other resources can be left as is or saved as text `.tres`. These external files can be shared with other scenes.
10. Read the [Wiki](https://github.com/TokisanGames/Terrain3D/wiki) to learn how to properly [set up your textures](https://github.com/TokisanGames/Terrain3D/wiki/Setting-Up-Textures), [import data](https://github.com/TokisanGames/Terrain3D/wiki/Importing-&-Exporting-Data) and more.

## Getting Support

1. Most questions have already been addressed in the [Wiki](https://github.com/TokisanGames/Terrain3D/wiki), especially [Troubleshooting](https://github.com/TokisanGames/Terrain3D/wiki/Troubleshooting) and [Setting Up Textures](https://github.com/TokisanGames/Terrain3D/wiki/Setting-Up-Textures).

2. For questions or technical issues, join the [Tokisan discord server](https://tokisan.com/discord) and look for the #terrain-help channel.

3. For technical issues or bug reports, search through the [issues](https://github.com/TokisanGames/Terrain3D/issues) to ensure it hasn't already been reported, then create a new one. Use discord for questions.

## Credit
Developed for the Godot community by:
Expand Down
Binary file modified doc/docs/images/terrain3d.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions doc/docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Installation

## Requirements
* Supports Godot 4.1+. [4.0 is possible](previous_engines.md).
* Supports Windows, Linux, and macOS. Other platforms pending.
* Supports Windows, Linux, and macOS. Other platforms are [pending](project_status.md).

## Run the demo
1. Download the [latest release](https://github.com/TokisanGames/Terrain3D/releases) and extract the files, or [build the plugin from source](building_from_source.md).
Expand All @@ -23,6 +23,6 @@ If it isn't working for you, see [Troubleshooting](troubleshooting.md) and [Gett
7. Select `Project / Reload Current Project` to restart once more.
8. Create or open a 3D scene and add a new Terrain3D node.
9. Select Terrain3D in the Scene panel. In the Inspector, click the down arrow to the right of the `storage` resource and save it as a binary `.res` file. The other resources can be left as is or saved as text `.tres`. These external files can be shared with other scenes.
10. Learn how to properly [set up your textures](textures.md), and [import data](import_export.md).
10. Click Next to learn how to properly [set up your textures](textures.md), or skip to [import data](import_export.md).

If it isn't working for you, see [Troubleshooting](troubleshooting.md) and [Getting Help](getting_help.md).
4 changes: 2 additions & 2 deletions doc/docs/textures.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ Texturing the Terrain

Terrain3D supports up to 32 texture sets using albedo, height, normal, and roughness textures. This page describes everything you need to know to set them up.

TLDR: Just read channel pack with Gimp.
TLDR: Just read channel pack textures with Gimp.

**Table of Contents**
* [Required Texture Format](#required-texture-format)
* [Channel pack images with Gimp](#channel-pack-textures-with-gimp)
* [Channel pack textures with Gimp](#channel-pack-textures-with-gimp)
* [Where to get textures](#where-to-get-textures)
* [Frequently Asked Questions](#faq)

Expand Down
16 changes: 4 additions & 12 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
contain the root `toctree` directive.
.. |logo| image:: docs/images/terrain3d.png
:target: _images/terrain3d.png

|logo|

Expand All @@ -12,10 +13,10 @@ Terrain3D Documentation

`Terrain3D <https://github.com/TokisanGames/Terrain3D>`_ is a high performance, editable terrain system for Godot 4.

Installation
-------------
Usage
--------

See :doc:`Installation <docs/installation>`.
Read all of the documents in the Getting Started section on the left, beginning with :doc:`Installation <docs/installation>`.

Credit
-------------
Expand Down Expand Up @@ -114,12 +115,3 @@ Geometry clipmap mesh code created by `Mike J. Savage <https://mikejsavage.co.uk
:caption: API

api/index



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

0 comments on commit 4c752bd

Please sign in to comment.