Difference between revisions of "Awakening Server Mod"

From Wurm Unlimited
Jump to navigation Jump to search
Line 138: Line 138:
  
 
[[Category:Mods]]
 
[[Category:Mods]]
 +
[[Category:Server Mods]]
 
[[Category:Kenabil]]
 
[[Category:Kenabil]]
 
[[Category:Awakening]]
 
[[Category:Awakening]]

Revision as of 10:45, 5 September 2020

Release of the public Awakening Server mod, which is an extract of the original mod on the Awakening server. Selected parts have been compiled into this package, while code bound to server specific lore and standards has been left out. The main functionality in this mod consists of:

  1. A number of custom GM/CM commands as well as player commands.
  2. Leaderboards for skills and overall top player based on top 10 skills.
  3. Custom trait functionality.
  4. Offspring names.
  5. Block dropping dirt on enemy deeds (PvP).
  6. Block oak and willows from spreading.
  7. Custom pet handling, pets normally don't attack hostile creatures, unless given attack command.
  8. Use old (WO) skill gains for meditation skill.
  9. Block farm tiles on deed from growing unless tended.
  10. Custom player settings.
  11. Use old style meditation skill gains. Fix to make meditation work like on Wurm Online.
  12. Block alts; only one alt can login at the same time, or alternatively - block cross-kingdom alts.
  13. Send server lag reports.
  14. Kingdoms may become allies (PvP).
  15. Anti macro handling.
  16. Decay on locks, when owner has abandoned server for a long time. Locks rust and fall off and unplant.
  17. Unlocked vehicles can be claimed by embarking as driver, changes owner.
  18. Plagues, it will lower creature population over time if max number of creatures have been lowered.
  19. Kingdom inventory supplier, adds trader items to listed merchants.

All features can be switched on/off in the awakening.properties file.

Disclaimer

Please note that this mod wasn't developed for public release, it was developed for the Awakening server, and parts of that code has been packaged into this mod. Therefore some features may seem strange or out of place because there are originally made for certain lore and ideals, so please keep that in mind. Also, all possible combinations of properties have not been tested, some combinations may not work properly. If you notice any bugs, please report them by PM to Kenabil either on discord or the forum.

Awakening Properties

The following properties are available for the properties file, values can be either hard or soft; hard means changes requires a server restarts, soft means properties can be reloaded without requiring a server restart. All boolean properties, i.e. those with true/false values, always default to false, so you can safely remove all properties and only turn those features on that you want.

Please note that there are a lot of properties, and it takes quite a lot of time to write documentation, so there will come explanations for all properties, just be patient. Most property-names are hopefully self-explanatory to some degree.

useCommandHandler (true|false, soft)
Whether to use custom commands. Most custom commands will write usage instructions when entering the command without arguments. Some commands doesn't have any arguments, if so the description will say so.
handleCommandConfig (true|false, soft)
Adds the GM-command: #config -- Reloads the Awakening properties file. Note, no other properties file is reloaded.
handleCommandRestore (true|false, soft)
Adds the GM-command: #restore -- This command makes it possible to restore parts of the map to the shape of another map. You need to upload the other map, which for example could be the original version of the map at server start. Then load the other map into memory with the restore-command, and then use the restore-command to restore the map to the other version. Make sure to backup the map in case something would go wrong.
handleCommandAlts (true|false, soft)
Adds the GM/CM-command: #alts -- List all characters sharing the same steam ID or IP address, which may or may not be alts.
handleCommandMonitor (true|false, soft)
Adds the GM/CM-command: #monitor
handleCommandPvP (true|false, soft)
Adds the GM/CM-command: #pvp
handleCommandKarma (true|false, soft)
Adds the GM-command: #karma
handleCommandRotate (true|false, soft)
Adds the GM-command: #rotate
handleCommandInventory (true|false, soft)
Adds the GM-command: #inventory
handleCommandTransfer (true|false, soft)
Adds the GM-command: #transfer
handleCommandSQL (true|false, soft)
Adds the GM-command: #sql
handleCommandSchedule (true|false, soft)
Adds the GM/CM-command: #Schedule
handleCommandTile (true|false, soft)
Adds the GM-command: #tile
handleCommandSetResource (true|false, soft)
Adds the GM-command: #resource
handleCommandFlowersFix (true|false, soft)
Adds the GM-command: #flowersfix -- Used to fix bugged flowers on the map, i.e. flowers that doesn't exist.
handleCommandLag (true|false, soft)
Adds the command: #lag -- Show the amount of server lag in seconds since server start.
handleCommandBank (true|false, soft)
Adds the command: #bank -- Show money in the bank.
handleCommandPvPList (true|false, soft)
Adds the command: #pvp -- List all players with the PvP setting.
useLeaderBoard (true|false, hard)
Use the Awakening leaderboard. It adds a "Leaderboard" option when right clicking a skill in the skill-window, or in the Body-menu. By selecting it, a popup is opened with a top-ten list of the players with the highest skill-levels; or from the Body-meny, the top-ten players with the highest score of the average of their individual top-ten skills.
useLowerCaveCeiling (true|false, hard)
Feature to lower the ceiling in caves using concrete, works the same as raising floor.
useScheduler (true|false, hard)
Using the scheduler is required to use all scheduled features. This also includes saving player settings.
useItemCreationEntries (true|false, hard)
Adds a number of custom items and creation entries for many items that can't be created in vanilla Wurm.
usePlayerSettings (true|false, hard)
Adds an option in the Body-menu "Settings", with settings for opting to use PvP. What settings are available depends on what other features are turned on: On PvP servers, players can opt in for full PvP or limited PvP (this adds no special PvP game mechanics, only to show who are into PvP, on Awakening this is coordinated with special PvP rules and other servers may create other rules regarding this); opt in/out from all leaderboards (if leaderboards are turned on); For mayors theres a setting to disable custom deed farm growth (should be turned on to show); mayors can also select deed visibility on the map viewer.
useAcceptLoginDifferentIPs (true|false, hard)
useMayorsCanTurnUnlawful (true|false, hard)
useOffspringNames (true|false, hard)
useCustomPetHandling (true|false, hard)
usePlayerHoverText (true|false, hard)
useKingdomsMayAlly (true|false, hard)
useInitializeFarmToMidnightGMT (true|false, hard)
useFarmGrowthWhenTended (true|false, hard)
useAcceptingDeityNames (true|false, hard)
useIsTurnableFix (true|false, hard)
useIsMoveableFix (true|false, hard)
useCorpseColourCreatureFix (true|false, hard)
useCorpseSizeCreatureFix (true|false, hard)
useAdjustSizeByTraits (true|false, hard)
useAdjustMilkByTraits (true|false, hard)
useAdjustWoolByTraits (true|false, hard)
useBrandNullPointerFix (true|false, hard)
useMayDropDirt (true|false, hard)
useCheckForTreeSprout (true|false, hard)
useContinueInHouseWithoutManage (true|false, hard)
useCanAllowEveryone (true|false, hard)
useVillagePermissionsPvEzone (true|false, hard)
useCanPlantMarkerBlessed (true|false, hard)
useOldSkillMeditation (true|false, hard)
useOneCharacterPerSteamId (true|false, hard)
useCharactersOnlySameKingdom (true|false, hard)
useHandleServerLag (true|false, hard)
serverLagReportTime (default 10 minutes, soft)
antiMacroHandling (true|false, hard)
antiMacroPunishing (true|false, soft)
antiMacroPatternedActionTime (default 300 milliseconds, soft)
antiMacroPatternedActions (default 100 actions, soft)
antiMacroRobotActionsCounter (default 15 actions, soft)
Number of actions after the robot question has been sent, after which it will be considered macroing.
antiMacroRobotTestTimeMin (default 120 minutes, soft)
antiMacroRobotTestTimeMax (default 240 minutes, soft)
antiMacroRobotPunishTime (default 10 minutes, soft)
antiMacroRandomActionsMin (default 1000 actions, soft)
antiMacroRandomActionsMax (default 2000 actions, soft)
useDecayAbandonedLocks (true|false, hard)
decayAbandonedLocksDays (default 90 days)
decayAbandonedLocksPVEOnly (true|false, hard)
decayAbandonedLocksUnplant (true|false, hard)
useClaimByEmbarkUnlockedVehicle (true|false, soft)
usePlagues (true|false, hard)
Adds plagues to the server, causing random death to creatures in excess of maximum number of creatures.
plagueRadius (default 50 tiles, soft)
Each plague hit, creatures within a random circle with this radius are killed.
plagueMinPopulation (default 500 creatures, soft)
If population of a creature type is lower then this number, they are spared from the plague.
plagueMaxCreaturesMargin (default 1000 creatures, soft)
Margin added to maximum number of creatures.
useInventorySupplier (true|false, hard)
Resupply merchants with common trader wares (daily at 7, Wurm time):
kingdomTrader_1=<wurmId>
kingdomTrader_2=<wurmId>
etc.