Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@Zamirathe
Zamirathe committed Jul 9, 2015
1 parent 123efad commit 7b4f99b
Showing 1 changed file with 44 additions and 31 deletions.
75 changes: 44 additions & 31 deletions README.md
View file
Expand Up @@ -7,13 +7,15 @@ Here is my take on the old Feast that was available for 2.2.5. My version, you
<?xml version="1.0" encoding="utf-8"?>
<FeastConfiguration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<Enabled>true</Enabled>
<minDropTime>600</minDropTime>
<maxDropTime>900</maxDropTime>
<dropRadius>20</dropRadius>
<minItemsDrop>10</minItemsDrop>
<maxItemsDrop>25</maxItemsDrop>
<skyDrop>false</skyDrop>
<skyRadius>10</skyRadius>
<MinDropTime>600</MinDropTime>
<MaxDropTime>1200</MaxDropTime>
<DropRadius>20</DropRadius>
<MinItemsDrop>5</MinItemsDrop>
<MaxItemsDrop>25</MaxItemsDrop>
<SkyDrop>false</SkyDrop>
<PlaneEffectId>1001</PlaneEffectId>
<SkydropEffectId>1006</SkydropEffectId>
<MessageColor>red</MessageColor>
<Items>
<FeastItem>
<Id>66</Id>
Expand All @@ -28,17 +30,15 @@ Here is my take on the old Feast that was available for 2.2.5. My version, you
<Name>Military Ammunition Box</Name>
<Chance>10</Chance>
<Locations>
<string>Ontario</string>
<string>New Brunswick</string>
<string>all</string>
</Locations>
</FeastItem>
<FeastItem>
<Id>44</Id>
<Name>Civilian Ammunition Box</Name>
<Chance>10</Chance>
<Locations>
<string>Ontario</string>
<string>New Brunswick</string>
<string>all</string>
</Locations>
</FeastItem>
<FeastItem>
Expand All @@ -62,62 +62,75 @@ Here is my take on the old Feast that was available for 2.2.5. My version, you
<Name>Police Vest</Name>
<Chance>10</Chance>
<Locations>
<string>Ontario</string>
<string>New Brunswick</string>
<string>all</string>
</Locations>
</FeastItem>
<FeastItem>
<Id>251</Id>
<Name>White Travelpack</Name>
<Chance>10</Chance>
<Locations>
<string>Ontario</string>
<string>New Brunswick</string>
<string>all</string>
</Locations>
</FeastItem>
<FeastItem>
<Id>223</Id>
<Name>Police Top</Name>
<Chance>10</Chance>
<Locations>
<string>Ontario</string>
<string>New Brunswick</string>
<string>all</string>
</Locations>
</FeastItem>
<FeastItem>
<Id>224</Id>
<Name>Police Bottom</Name>
<Chance>10</Chance>
<Locations>
<string>Ontario</string>
<string>New Brunswick</string>
<string>all</string>
</Locations>
</FeastItem>
<FeastItem>
<Id>366</Id>
<Name>Maple Crate</Name>
<Chance>10</Chance>
<Locations>
<string>Ontario</string>
<string>New Brunswick</string>
<string>all</string>
</Locations>
</FeastItem>
</Items>
<msgComingFeast>The feast is beginning at {0} in {1} minutes!</msgComingFeast>
<msgNowFeast>The feast is now at {0}!</msgNowFeast>
</FeastConfiguration>
```

Most of these should be self explanatory.

enabled: set to false if you really want to turn the feast off but not remove it from your server.
minDropTime and maxDropTime is the range of time between feast drops in seconds. If you set both to the same number, it will be a set time.
dropRadius is how far from the location point they should randomly drop. Default is 20 spaces.
minItemsDrop and maxItemsDrop is the range of number of items to be dropped each time.
skyDrop and skyDropRadius: If set to true, the items will then spawn anywhere between 1 and the amount set on skyDropRadius in the air and fall to the ground. Yes, they can fall on roofs.
FeastItem is a required piece. It gives all the info the feast needs to drop a certain type. Name doesn't have to be exact, but id does. Chance is how many times to add that id into the pot. 10 is default for 10 types. (10 items, 10 times each, makes it 10% chance each item will be this specific item.)
Enabled: set to false if you really want to turn the feast off but not remove it from your server.

MinDropTime and MaxDropTime is the range of time between feast drops in seconds. If you set both to the same number, it will be a set time.

DropRadius is how far from the location point they should randomly drop. Default is 20 spaces.

MinItemsDrop and MaxItemsDrop is the range of number of items to be dropped each time.

SkyDrop: If set to true, a series of effects will run and show an airdrop. (Thank you Sven!!) Needs the RocketEffects Plane Bundle located at http://steamcommunity.com/sharedfiles/filedetails/?id=461458943. Just subscribe to it and it will be downloaded to your client side. Then copy the 461458943 folder located in you client workshop folder (on windows usually C:\Program Files (x86)\Steam\steamapps\workshop\content\304930) to the server workshop folder in Bundles\Workshop\Content. The server will then send it to the players as needed. Also requires Debris graphic setting to be on to be seen. (Will not work if on Off.)

PlaneEffectId and SkydropEffectId are needed if SkyDrop is set true. The planes are from 1001 to 1005. SkydropEffect is only 1006 right now.

MessageColor: Set to a color by name or hex to give the feast messages sent to chat it's own color.

FeastItem is a required piece. It gives all the info the feast needs to drop a certain type. Name doesn't have to be exact (only for your reference), but id does. Chance is how many times to add that id into the pot. 10 is default for 10 types. (10 items, 10 times each, makes it 10% chance each item will be this specific item.)

Locations is the most configurable. Just put all, and that item will drop at all locations, or you can specify 1 or more locations for that item to drop. So you can have items drop in one location and not another. The names come from the map nodes, and they do have to be exact to take.
The two messages are what is sent to global chat before and during a feast.

All items are set to be removed when Unturned itself looks to sweep items that have been moved. A message will be printed to the console that has the time and location of the next feast for logging purposes.

If you delete the configuration file, the system will recreate it on a restart but it will print a warning that it could not find it and disable the feast. Just edit your config and restart the server.
If you delete the configuration file, the system will recreate it on a restart but it will print a warning that it could not find it and disable the feast. Just edit your config and restart the server.

Now includes a translation file for the two messages sent to chat.

```xml
<?xml version="1.0" encoding="utf-8"?>
<Translations xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<TranslationEntry Id="coming_feast_msg" Value="The feast is beginning at {0} in {1} minutes!" />
<TranslationEntry Id="now_feast_msg" Value="The feast is now at {0}!" />
</Translations>
```

0 comments on commit 7b4f99b

Please sign in to comment.