Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
khanghugo committed Jun 7, 2024
1 parent e215b9c commit f3907a6
Showing 1 changed file with 16 additions and 4 deletions.
20 changes: 16 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
# gchimp

A collection of various GoldSrc mapping tools with proper graphical interface
A collection of various GoldSrc mapping tools with both graphical and command line interface

![default](./docs/screenshot_s2g_populated.png)

## Installation

Check wiki page (TBA)
Head to [Release](https://github.com/khanghugo/gchimp/releases) page to download the app or latest [Actions](https://github.com/khanghugo/gchimp/actions) commits.

Usually it would just work out of the box. If there is any problem, try starting the binary through terminal and you will see the program output to better diagnose the issue.

## Features

Expand All @@ -16,13 +18,23 @@ Source to GoldSrc models converter. Supports folder conversion.

### SkyMod

Creates skybox as a model. Supports texture size bigger than the typical 512x512
Creates skybox as a model. Supports texture size bigger than the typical 512x512.

### Command line interface

Some functionalities have command line as well as graphical supports. There is also .rhai scripting for a selected few functionalities.

### QC, SMD, MAP

You can write your own functionalities with these included libraries.

### Planned features

- [ ] A Wally replacement
- [ ] A functional enough Wally to edit WAD files
- [ ] [map2prop](https://erty-gamedev.github.io/Docs-Map2Prop/) clone that hopefully goes open source before the original project

## Build

After building the project, put `config.toml` from `dist` folder into the same folder as the binary `gchimp`

Then, download [no_vtf](https://sr.ht/~b5327157/no_vtf/) and put the `no_vtf` folder inside `dist`

0 comments on commit f3907a6

Please sign in to comment.