Giter Club home page Giter Club logo

vsprospectorinfo's Introduction

VsProspectorInfo

A clientside only mod to save trees by not having to write down the values of your prospecting.

Installation

Just drop the file into your mods folder. You just need this mod on the client, no serverside installation needed.

Commands

.pi - main command for the mod and the default sub-command is to 'showoverlay', which will toggle the rendering of the texture on the map
.pi showoverlay [true,false] - Sending no arguments will simply toggle the value of the RenderTexturesOnMap config option. Sending either true or false, will set the config option to the appropriate value
.pi setcolor [0-255] [0-255] [0-255] [0-255] - Set's the value of the TextureColor field in the config & rebuilds the texture.
.pi setbordercolor [0-255] [0-255] [0-255] [0-255] - Set's the value of the BorderColor field in the config & rebuilds the texture.
.pi setborderthickness [number] - Set the BorderThickness value in the config & rebuilds the texture.
.pi toggleborder [true,false] - Set's the `RenderBorder` value in the config & rebuilds the texture.
.pi showgui - Shows the GUI where you can configure the mode (default or heatmap) and select the ore that should be heatmapped

Configuration

TextureColor [0-255] [0-255] [0-255] [0-255] - The default color to use for the texture. Default: 7 52 91 50
BorderColor [0-255] [0-255] [0-255] [0-255] - The default color to use for the border texture. Default: 0 0 0 200
BorderThickness [number] - The thickness, in pixels, of the border color. Default: 1
RenderBorder [true,false] - Whether or not to render the border at all. Default: true
AutoToggle [true,false] - Whether or not to toggle the texture on map automatically, based on the player equipping/unequipping a prospecting pick. Default: true

Usage

Whenever you finish prospecting a chunk, the data is saved into the ModData folder and added to the chunk info of the world map. This is just a 1:1 parsing of the chat message that the prospecting pick sends.

The mod renders a transparent square of all chunks that have been prospected. If a chunk is re-prospected, the message is simply overwritten. The rendering of these squares can be toggled with the .pi command.

After prospecting, the info will be displayed in the tooltip of the minimap when hovering over the chunk. This info is stored in %Vintage_Story_Data%/ModData/YourWorldId/vsprospectorinfo.data and is client side only.

image

Heatmap

A map mode that displays the relative density of the ores on the map via a color gradient. Can be enabled/disabled and switched between displaying the density of just one ore and displaying the density of all ores (The highest density per chunk is picked).

Normal map (map mode 0) map

Heatmap (map mode 1) heatmap

Heatmap for Cassiterite only (map mode 1; heatmapore Cassiterite) heatmapCassiterite

Compiling

Clone the repository with submodules included: "git clone --recursive" To compile the mod you also need to set 2 environment variables:

  • VINTAGE_STORY => the path to the game directory e.g. c:\games\vintagestory
  • VINTAGE_STORY_DATA => the path to the games data directory typically located somewhere in appdata e.g. C:\Users\MyUser\AppData\Roaming\VintagestoryData

Create a release

To create a release just compile the solution in Release configuration. A folder named "release" should appear in the solution directory. This can then be zipped to be uploaded to the mod-db.

vsprospectorinfo's People

Contributors

ggguenni avatar p3t3rix avatar coy-allen avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.