ctcdnightmare / avorion-scrapyardplus Goto Github PK

1.0 3.0 4.0 626 KB

ScrapyardPlus - a mod for Avorion

Lua 94.47% Shell 5.53%

avorion lua mod gamemod hacktoberfest

avorion-scrapyardplus's Introduction

ScrapyardPlus

Your salvaging ops are longer then 60 minutes?
You want to get something in return for grinding all the precious reputation?

With ScrapyardPlus you can:

buy up to 8 hours total (depending on your reputation)
increment your current license in variable intervals from 5 minutes all the way up to 3 hours per order
get discounts for bulk orders and your current standing with the owner of the scrapyard
earn a lifetime-license for yourself or your alliance and never have to bother with buying an extension again (lifetime status is granted faction-wide!)
configure all important things to suit your (or your servers) needs (data/config/scrapyardplus.lua)

Installation (without steam workshop)

download & extract the mod into %AppData%\Avorion\mods\ folder on Windows or ~/.avorion/mods/ on Unix-based systems
done

Default Config

-- general
config.enableDebug = false -- [Default: false] Enable/Disable detailed log output
config.alliancePriceFactor = 4.5 -- [Default: 4.5] How much alliances have to pay more for a salvaging license
config.pricePerMinute = 175 -- [Default: 175] Price per one minute of salvaging

-- timers / announcements
config.advertisementTimer = 120 -- [Default: 120] Time (in seconds) when the scrapyard will spam the system with "get a license now"
config.expirationTimeNotice = 600 -- [Default: 600] Time (in seconds) at which the first reminder will be send to players/alliances about their license running out
config.expirationTimeWarning = 300 -- [Default: 300] Time (in seconds) at which the second reminder will be send to players/alliances about their license running out
config.expirationTimeCritical = 120 -- [Default: 120] Time (in seconds) at which the third reminder will be send to players/alliances about their license running out
config.expirationTimeFinal = 30 -- [Default: 30] Time (in seconds) at which the FINAL reminder will be send to players/alliances about their license running out

-- lifetime
config.allowLifetime = true -- [Default: true] Enable/Disable the ability to get lifetime salvaging licenses
config.lifetimeRepRequired = 100000 -- [Default: 100000] Minimum required reputation before you start to gather experience towards lifetime
config.lifetimeExpTicks = 1000 -- [Default: 1000] Actions (in ticks) after the player/alliance will get experience
config.lifetimeExpRequired = 100000 -- [Default: 100000] Amount of experience to unlock lifetime-license
config.lifetimeExpFactor = 0.75 -- [Default: 0.75] Factor to de-/increase the base experience calculation
config.lifetimeAllianceFactor = 0.5 -- [Default: 0.5] Factor to de-/increase the amount an alliance will get compared to a player
config.lifetimeExpBaseline = 7 -- [Default: 7] Base value of experience that's always granted

-- high traffic system
config.highTrafficChance = 0.3 -- [Default: 0.3] Chance that a discovered system is regenerative
config.enableRegen = true -- [Default: true] Enable/Disable the regeneration of wrecks inside a system
config.regenSpawntime = 15 -- [Default: 15] Time (in minutes) how often new event will start to spawn wrecks

-- events
config.enableDisasters = false -- [Default: true] Enable/Disable events from the (G)lobal (O)rganization of (D)isasters
config.disasterChance = 0.03 -- [Default: 0.03] Chance that something bad will happen
config.disasterSpawnTime = 20 -- [Default: 30] Time (in minutes) how often it's checked if bad things will happen

Screenshots

Solo player after getting his first license

Alliance player with normal reputation

Nearly reached lifetime status but lost reputation before finishing it

Finally reached lifetime status

Roadmap

~~extend your current license instead of overwriting it~~
~~longer maximum duration for your license~~
~~reputation based benefits (max duration and discount)~~
~~split the license system into private & alliance so you can buy a personal one even if you are in an alliance~~
~~flexible duration selection via slider~~
~~lifetime license~~
~~regenerating wrecks / events to support lifetime licenses~~
polishing current implementation with more texts, events, interactions

Feedback & Discussion

http://www.avorion.net/forum/index.php/topic,3850.0.html

Mentions & shoutouts

Dirtyredz - He got me into modding for Avorion with his MoveUI-Mod and now we are even working together on each others mods to further improve our knowledge
slxsh - For creating the two license icons
bariskisir - For adding the turkish translation
OleksiyRudenko - For adding the russian translation
Balkoth - For adding the french translation

avorion-scrapyardplus's People

Contributors

Stargazers

Watchers

Forkers

slxsh poissoj fly-man- shrooblord

avorion-scrapyardplus's Issues

Create two icons for solo & alliance licenses (game not required!)

As you can see here the current version of the game changed the tabs to now have icons instead of text.
I am no gfx artist so it would be nice if someone could help me out by creating two icons which represent the two types of licenses one can buy at the station:

scrapyard license for solo pilot
scrapyard license for an alliance

Could also just be a variation of one icon with the letters S and A on it or incorporate the original alliance & player icons somehow.
The icons should be named scrapyardplus-license-solo.png and scrapyardplus-license-alliance.png and be 512x512px in size. They should be placed in the src/data/textures/icons folder

Don't worry about how they will be implemented in the code, I'll take care of it.
So this task is also suitable for people who don't own the game and just want to help.
If you want to be mentioned in the steam-workshop as contributor and happen to have a steamaccount, just drop me your steam-account via PM and I'll add you as soon as the new release is pushed out.

For reference THIS is a selection of the original icons and their style.

Extend current Eventsystem

As it stands right now, the eventsystem is more of a skeleton or boilerplate without any real functionality.

If you want to help, take a look inside:

mods/ScrapyardPlus/scripts/events/ScrapyardPlus.lua

to see what i have in mind at the moment.

It's not set in stone and I'm open for ideas and feedback.
If someone wants to tackle spawning ships etc, feel free to get going and open a PR afterwards :)

Add turkish translation to the mod (game not required!)

Currently the mod only includes english texts and the german translations for them.

The core game supports turkish as well and the mod would need someone who knows the language to translate the couple of texts it uses.