GoGRF

README

GoGRF

This is a tool to generate a NewGRF nml definition using Go.

Installation

go get github.com/SwatBros/GoGRF

Usage

Create a new Go project and create a GrfDefinition struct. In the main function, call the Generate function with the GrfDefinition struct.

package main

import (
    "github.com/SwatBros/GoGRF"
    //...
)

func main {
    definition := GoGRF.GrfDefinition{
        //...
    }

    Generate(definition)
}

License

MIT License

Copyright (c) 2024 Alessio Disarò

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Documentation

Index

• func Generate(definition *GrfDefinition) error
• type Cargo
• type Grf
• type GrfDefinition

Functions

func Generate

func Generate(definition *GrfDefinition) error

Types

type Cargo

type Cargo struct {
	Id                        int
	Type_name                 string
	Unit_name                 string
	Units_of_cargo            string
	Items_of_cargo            string
	Type_abbreviation         string
	Sprite                    string
	Weight                    int
	Penalty_lowerbound        int
	Single_penalty_length     int
	Price_factor              float32
	Station_list_colour       int
	Cargo_payment_list_colour int
	Is_freight                bool
	Cargo_classes             enums.Cargo_classes
	Cargo_label               string
	// Town_growth_effect
	Town_growth_multiplier float32
	// Callback_flags
	Capacity_multiplier float32
	// Town_production_effect
	Town_production_multiplier float32
}

type Grf

type Grf struct {
	Name                   string
	Description            string
	Version                int
	Min_compatible_version int
}

type GrfDefinition

type GrfDefinition struct {
	Grf    Grf
	Cargos []Cargo
}