-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adds tool link directory for extra tools used
Adds forum posts for pre-release editing
- Loading branch information
ForsakenShell
committed
Oct 19, 2015
1 parent
7298576
commit d447a69
Showing
7 changed files
with
219 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
[center][img]https://github.com/RimWorldCCLTeam/CommunityCoreLibrary/blob/master/WebGraphics/CCL_Logo_Long.png?raw=true[/img] | ||
v0.12.4[/center] | ||
|
||
|
||
|
||
[size=12pt][color=orange]Basic Description[/color][/size] | ||
|
||
This is a basic set of functions which modders can use to enhance their RimWorld mods. Most of the library can be used from xml without any additional C# skill or requirement. | ||
|
||
If you are a user which has a mod using CCL, you only need to download the latest CCL release zip. Make sure it is enabled after the 'Core' mod and before any mod requiring CCL. | ||
|
||
If you are a modder, download the modders resource or the source package. | ||
|
||
|
||
|
||
[size=12pt][color=orange]Download[/color][/size] | ||
|
||
[size=12pt]Regular users download the "User Release" package.[/size] | ||
[list][li]Extract both the folders in the zip into your Mods folder.[/li] | ||
[li]Enable "Community Core Library" after "Core"[/li] | ||
[li]Enable "Community Core Library - Vanilla Tweaks" after "Community Core Library" - The vanilla tweaks is entirely optional but highly recommended.[/li][/list] | ||
|
||
[size=12pt]Modders download the "Modders Resource" package.[/size] | ||
[list][li]Do not unzip this into Mods.[/li] | ||
[li]Install the two mod folders ("Community Core Library" and "Community Core Library - Vanilla Tweaks") into your Mods directory and enable them as usual.[/li] | ||
[li]Check your output_log.txt! It will contain valuable information if CCL encounters errors when handling your mod! This will help you fix those trivial bugs.[/li] | ||
[li]Always refer to "Def Descriptions" and "Examples" for how to use this library.[/li] | ||
[li]If something is not covered, please ask a question. Be ready to be given a polite "rtfm" if it is covered in the docs. ;)[/li][/list] | ||
|
||
[size=12pt]C# Developers[/size] | ||
[list][li]If you are simply wanting to mod and take advantage of CCL, use the source download or fork from the master branch.[/li] | ||
[li]If you want to contribute, bug fix, nitpick, etc, you should fork from the unstable development branch and propose changes through pull requests.[/li][/list] | ||
|
||
[size=12pt]Download[/size] | ||
[url=https://github.com/RimWorldCCLTeam/CommunityCoreLibrary/releases/latest]From github[/url] | ||
|
||
|
||
|
||
[size=12pt][color=orange]Background[/color][/size] | ||
|
||
This project started in Alpha 9, continued to be developed in Alpha 10 (some ideas had to be dropped due to complexity) and is finally available for Alpha 11. Ideas and suggestions plus a lot of help came from the RimWorld community on the Ludeon Forums. If you have an idea which fits into the context of CCL, please leave feedback or better, develop your idea and submit code! CCL and it's team could always be fleshed out with additional talent! | ||
|
||
|
||
|
||
[size=12pt][color=orange]Final Notes[/color][/size] | ||
|
||
If all else fails, [i]read[/i] [b]all[/b] of the above, don't skim over anything. Especially read "note" sections. | ||
|
||
Always do a "clean" install. Delete the old version from /mods/ before copying the new version. Do [i]not[/i] overwrite an existing copy. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
[size=12pt][color=orange]What the "Core" mod offers[/color][/size] | ||
|
||
[color=orange]Help Menu[/color] | ||
With the help system implemented in v0.12.0, CCL will generate help for most of the standard things you'd expect to find help for. You can easily navigate buy clicking directly on list items in the description and for items not in the help database, it will provide a tool-tip when hovering the mouse over the item. | ||
|
||
The list of auto-generated help includes virtually every in-game object and more information is added with each new release of CCL. This help will tell you virtually everything you can need about the topic including but not limited to item stats, research requirements, recipes, etc. | ||
|
||
[color=orange]Research Menu[/color] | ||
The research menu provides the same information as the help menu on the topic as well as quick access to research requirements and children. | ||
|
||
[color=orange]Proper Refrigeration[/color] | ||
Buildings implementing refrigeration will refrigerate rottable items without the usual "rot-unrot" cycle. CCL automatically replaces the vanilla rotting component on items with a new component which handles refrigerated buildings properly by simply not rotting the item. | ||
|
||
|
||
|
||
[size=12pt][color=orange]What the "Vanilla Tweaks" mod offers[/color][/size] | ||
|
||
[color=orange]Power Savings[/color] | ||
Most buildings will not draw power when they are not in use. This includes the cookstove, machining table, etc but will remain connected to the power grid. Some exceptions include the comms console which always draws full power. | ||
|
||
Auto Doors draw less power when they are not actually opening or closing. | ||
|
||
Hydroponics basins "cycle" power at a rate of 50W for 5000 ticks and then 100W for 2500 ticks and will offer to share their growing options with other hydroponics basins. | ||
|
||
[color=orange]Advanced Research Recipes[/color] | ||
Artillery Shells require 'Mortars' research to be complete before they are available to be crafted at the smithing and machining workbenches. Hops requires 'Brewing' before it can be planted and grown. | ||
|
||
[color=orange]Colored Lights[/color] | ||
The standing lamps have been reduced to a single object which takes advantage of a new comp allowing dynamic color changes on a single building, reducing the architects menu clutter. | ||
|
||
[color=orange]Neighbourly Growers[/color] | ||
Hydroponic basins and plant pots can share growing information with other hydroponic basins and plant pots. No need to select each grower individually when setting everything up. | ||
|
||
[color=orange]Remember![/color] | ||
All changes are defined in xml in the Vanilla Tweaks. If you only want the core library, don't enable the tweaks. If you do use the tweaks, you can change [i][b]ANYTHING[/b][/i] as it's all defined in xml! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
[size=12pt][color=orange]As a modder, you will be interested in[/color][/size] | ||
|
||
[size=10pt][color=orange]New Defs[/color][/size] | ||
[list][li][color=orange]Advanced Research[/color] - Allows recipes and buildings to be locked and unlocked by multiple research requirements.[/li] | ||
[li][color=orange]Mod Helper[/color] - Define MapComponents, Designators and ThingComps to be injected as well as minimum CCL version dependency.[/li] | ||
[li][color=orange]Help [Category][/color] - Define in-game help which is accessible from the main tab beside research (by default).[/li][/list] | ||
|
||
[size=10pt][color=orange]Def Extensions[/color][/size] | ||
[list][li][color=orange]Terrain With Comps[/color] - Allows usage of special place workers with terrain.[/li][/list] | ||
|
||
[size=10pt][color=orange]New Buildings[/color][/size] | ||
[list][li][color=orange]Hopper[/color] - A powerful hopper system which allows a generic hopper to be programmed with the items the machine (user) accepts and wants. This is the base building for hoppers. CCL provides two hoppers already (refrigerated and unrefrigerated).[/li] | ||
[li][color=orange]Hydroponics[/color] - Building_PlantGrower doesn't call base.TickRare(), this does. Useful if you have comps which need ticking.[/li] | ||
[li][color=orange]SunLamp Heat Controller[/color] - It's a sun lamp, it's a heater, it's controllable.[/li][/list] | ||
|
||
[size=10pt][color=orange]New Comp Properties[/color][/size] | ||
[list][li][color=orange]Colored Lights[/color] - Used to define the available colors and research requirement for CompColoredLight.[/li] | ||
[li][color=orange]Hopper User[/color] - XML definition of resource thing filter for hopper storage.[/li] | ||
[li][color=orange]Low Idle Draw[/color] - Defines the settings for how CompPowerLowIdleDraw modifies the power usage of the building.[/li] | ||
[li][color=orange]Restricted Placement[/color] - Defines the restrictions for place workers.[/li] | ||
[li][color=orange]Shearable Renameable[/color] - Allows you to specify the string which will show up for shearable animals instead of the default "wool."[/li][/list] | ||
|
||
[size=10pt][color=orange]New Interfaces[/color] (C#)[/size] | ||
[list][li][color=orange]IHopperUser[/color] - A programatic interface for programming hoppers. This allows for more powerful programming of a hoppers resource filter.[/li][/list] | ||
|
||
[size=10pt][color=orange]New ThingComps[/color][/size] | ||
[list][li][color=orange]Colored Lights[/color] - One building can have multiple glower colors defined (or it can use the default internal list of seven colors) and a button will be made available to the user to cycle through the options. The cycle button is hidden until the appropriate research is complete (by default "ColoredLights"). Additionally can program [i]other[/i] lights colors, respecting their own research. Uses color matching by name so your "red" and my "red" don't have to be the same red but are accepted as "red."[/li] | ||
[li][color=orange]Heat Pusher Powered[/color] - Exactly the same as the vanilla except it's aware of Low Idle Power.[/li] | ||
[li][color=orange]Hopper[/color] - Used as part of the generic hopper system. Provides hopper-side functions.[/li] | ||
[li][color=orange]Hopper User[/color] - Used as part of the generic hopper system. Provides user-side functions.[/li][li][color=orange]Lifespan Powered[/color] - The same function as CompLifespan but, this will only count-down it's life while it is actively powered.[/li] | ||
[li][color=orange]Low Idle Power[/color] - Allows anything[sup][size=8pt]1[/size][/sup] with a CompPowerTrader to draw less depending on it's operational mode. Current operational modes include "InUse", "WhenNear" and "Cycle."[/li] | ||
[li][color=orange]Neighbourly Grower[/color] - Adds gizmos to Building_PlantGrower derived buildings (such as Hydroponics) providing the user the ability to share growing information.[/li] | ||
[li][color=orange]Refrigeration[/color] - Flags any Building_Storage as preventing foods from rotting. Does not magically heal the food but prevents further decay so long as the building has power.[/li] | ||
[li][color=orange]Restricted Placement[/color] - Used to store settings for restricted place workers.[/li] | ||
[li][color=orange]Rottable Refrigerated[/color] [Internal] - Automatically replaces CompRottable and handles preventing foods from rotting when in a storage building flagged with CompRefrigerated. Inspection string reflects proper state of item.[/li] | ||
[li][color=orange]Shearable Renameable[/color] - Specify the inspection string name for the resource gathered by shearing.[/li][/list] | ||
|
||
[size=10pt][color=orange]New PlaceWorkers[/color][/size] | ||
[list][li][color=orange]NotOnTerrain/OnlyOnTerrain[/color][sup][size=8pt]2[/size][/sup] - Restricts placement to a list of valid terrain. Can be used to reject (Not) or accept (Only).[/li] | ||
[li][color=orange]NotOnThing/OnlyOnThing[/color][sup][size=8pt]2[/size][/sup] - Restricts placement to a list of valid things. Can be used to reject (Not) or accept (Only[sup][size=8pt]3, 4[/size][/sup]).[/li] | ||
[li][color=orange]OnlyOnSurface[/color][sup][size=8pt]2, 4[/size][/sup] - Only on an item surface. Useful for things which would be "on" something but not so specific as to the thing it's on.[/li] | ||
[li][color=orange]OnlyUnderRoof[/color][sup][size=8pt]2, 4[/size][/sup] - Require that a roof exist in the cell.[/li] | ||
[li][color=orange]RestrictedCount[/color][sup][size=8pt]2[/size][/sup] - Restrict the amount of buildings of a given type in the world.[/li] | ||
[li][color=orange]WallAttachment[/color][sup][size=8pt]2, 4[/size][/sup] - Requires a supporting wall (natural or man-made) to build against. If you want to build something in the same cell as a wall, use OnlyOnThing instead.[/li][/list] | ||
|
||
[size=10pt][color=orange]Notes[/color][/size] | ||
[list=1][li]Building's which directly control their own power are the obvious exception (eg: heaters, coolers, etc)[/li] | ||
[li]Requires RestrictedPlacement_Comp and RestrictedPlacement_Properties for information and/or support ticking.[/li] | ||
[li]Want to place that building [i]on[/i] (instead of [i]near[/i]) a steam geyser? You can. See the Geothermal Generator.[/li] | ||
[li]Depending on your needs, use a normal or rare ticker to fire the periodic check to make sure the supports still exist. If the support is removed, the thing is destroyed and an alert is fired to inform the player. Normal tickers only check every 250 ticks.[/li][/list] | ||
|
||
|
||
|
||
[size=12pt][color=orange]IMPORTANT NOTE TO MODDERS[/color][/size] | ||
[list][li]Do [b]NOT[/b] include any of CCLs assets with your mod directly.[/li] | ||
[li]Do [b]NOT[/b] copy the dll to your mods assembly directory.[/li] | ||
[li]Do [b]NOT[/b] copy the xml, languages, textures, etc unless your are explicitly overriding them with new settings. Doing so [b]WILL[/b] cause errors and will be the fault of the [i]modder[/i] who copies files they shouldn't.[/li][/list] | ||
If your mod needs CCL, then it needs CCL to be properly installed and loaded before your mod as a separate download, not included with. This is true for all mods and "mod packs." The only place users should be getting CCL from is the official github releases, any other place not an official copy (although perfectly legitimate, see [url=http://unlicense.org/]the unlicense[/url]) or the [i]modder[/i] using CCL has made a colossal mistake by packaging it directly with their mod. | ||
|
||
|
||
|
||
[size=12pt][color=orange]CCL Badging[/color][/size] | ||
|
||
If you have a mod using CCL, linking back to this thread is the best way to keep users running with the latest updates. | ||
|
||
[color=orange]Powered By[/color] | ||
[url=https://ludeon.com/forums/index.php?topic=14172.0][img]http://tinyurl.com/pd78ovl[/img][/url] | ||
|
||
[code][color=orange]Powered By[/color] | ||
[url=https://ludeon.com/forums/index.php?topic=14172.0][img]http://tinyurl.com/pd78ovl[/img][/url][/code] | ||
|
||
CCL logo and badge courtesy of [url=https://ludeon.com/forums/index.php?action=profile;u=2507]mrofa[/url]. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
[size=12pt][color=orange]Known Issues[/color][/size] | ||
|
||
Changing languages requires RimWorld to be restarted. | ||
|
||
There is a lot going on when RimWorld starts as far as CCL is concerned. The best practice is to restart RimWorld if you change any setting more complicated than the volume. | ||
|
||
|
||
|
||
[size=12pt][color=orange]Bug Reporting[/color][/size] | ||
|
||
Software of any complexity is bound to have bugs, CCL is no different. Please report bug by using the github issues tracker. This makes it faster and easier to get bugs fixed and they can be linked directly to the commit that fixes them. We appreciate feedback and want a bug free library for all but, with multiple team members, sending a PM or using the forum to report bug is now becoming inefficient. | ||
|
||
[url=https://github.com/RimWorldCCLTeam/CommunityCoreLibrary/issues]Report a bug[/url] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
[size=12pt][color=orange]The Team[/color][/size] | ||
[url=https://ludeon.com/forums/index.php?action=profile;u=32730]1000101[/url] | ||
[url=https://ludeon.com/forums/index.php?action=profile;u=8625]mipen[/url] | ||
[url=https://ludeon.com/forums/index.php?action=profile;u=35458]Latta[/url] | ||
[url=https://ludeon.com/forums/index.php?action=profile;u=12611]Fluffy (l2032)[/url] | ||
|
||
|
||
|
||
[size=12pt][color=orange]Contributors[/color][/size] | ||
DAOWAce | ||
kaptain_kavern | ||
profound_darkness | ||
mrofa | ||
isistoy | ||
noimageavailable | ||
|
||
|
||
|
||
[size=12pt][color=orange]Credit Where it's Due[/color][/size] | ||
[size=8pt](Excluding Tynan because it goes without saying. Also, if you'd like to implement anything from this into RimWorld, you are welcome to all the code!)[/size] | ||
|
||
Haplo for the [url=https://ludeon.com/forums/index.php?topic=3408.0]"How to make an [sic] .dll-mod"[/url] tutorial | ||
mipen for his [url=https://ludeon.com/forums/index.php?topic=7380.0]Mechanical Defence 2[/url] mod and through it's dissection the AdvancedResearchDef was born | ||
OpalMonkey for clueing me into [url=https://ludeon.com/forums/index.php?topic=12403.msg133986#msg133986]a better way to hide buildings[/url] behind research | ||
soltysek for spending countless hours reviewing My Bad Code (tm) | ||
mrofa for wasting his time reading my help forum threads and his general ideas (of which there are lots!) | ||
Vas for CompLifespanPowered (requested in [url=https://ludeon.com/forums/index.php?topic=14249.0]here[/url]) | ||
TheGentlmen (GENT) for tracking down and reporting many subtle bugs | ||
To anyone else may have been forgotten, you know who you are. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
[size=12pt][color=orange]Changelog[/color][/size] | ||
|
||
For the full list of changes in each version, please refer to the [url=https://github.com/RimWorldCCLTeam/CommunityCoreLibrary/pull/32]commit log[/url]. This section is just for convenience sake. | ||
|
||
[code]v0.12.4 - Many, many bugs fixed, help menu overhaul, research menu overhaul, new comp & property. | ||
v0.12.3b - Fixes Advanced Research Def to recognizes plants using plants with an override class. | ||
v0.12.3 - Bug fixes, Ice boxes (CompRefrigerated no longer *requires* CompPowerTrader but will respect it), Post Load Injectors, removes research requirement from Xerigium. | ||
v0.12.2 - Alpha 12d update. Refactors CompRefrigerated, fixes several bugs, graphics by mrofa. See the commit log for full detail. | ||
v0.12.1 - Alpha 12c update and bug-fixes. First release with AutoGen Help! | ||
v0.12.0 - Alpha 12 update. Adds menu help system and mod helper system. Separates vanilla tweaks from core. | ||
v0.11.4 - Fixes CompRefrigerated save/load issue, fixes lights and growers not sharing through link type properly sometimes, move repository to a team organization. | ||
v0.11.3 - Better placement restriction support. Now handles destroying things and alerting the player. | ||
v0.11.2 - Additional place workers, you can build on steam geysers, PlantGrowers can program other PlantGrowers, Lights can change other lights. | ||
v0.11.1 - Advanced research can now lock or unlock recipes and buildings. Adds Action callbacks to advanced research. Additional PlaceWorker restrictions. | ||
v0.11.0 - Initial public release[/code] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
[{000214A0-0000-0000-C000-000000000046}] | ||
Prop3=19,2 | ||
[InternetShortcut] | ||
URL=http://fenixproductions.dcmembers.com/bbc/ | ||
IDList= |