Skip to content

Commit affac83

Browse files
authored
Fix headers in integration readme (#3623)
1 parent 94f6405 commit affac83

File tree

1 file changed

+3
-3
lines changed
  • src/main/scala/li/cil/oc/integration

1 file changed

+3
-3
lines changed
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
This package contains code use to integrate with other mods. This is usually done by implementing block drivers for other mods' blocks, or by implementing (item stack) converters.
22

3-
###General Structure
3+
### General Structure
44
The general structure for mod integration is as follows:
55
- All mods' IDs are defined in `Mods.IDs` (`Mods.scala` file).
66
- For most mods, a `SimpleMod` instance suffices, some may require a specialized implementation. These instances are an internal way of checking for mod availablity.
@@ -9,7 +9,7 @@ The general structure for mod integration is as follows:
99

1010
Have a look at the existing modules for examples if that description was too abstract for you.
1111

12-
###On pull requests
12+
### On pull requests
1313
The basic guidelines from the main readme still apply, but I'd like to stress again that all integration must be *optional*. Make sure you properly test OC still works with and without the mod you added support for.
1414

1515
An additional guideline is on what drivers should actually *do*. Drivers built into OC should, in general, err on the side of being limited. This way addons can still add more "powerful" functionality, if so desired, while the other way around would not work (addons would not be able to limit existing functionality). Here's a few rules-of-thumb:
@@ -19,4 +19,4 @@ An additional guideline is on what drivers should actually *do*. Drivers built i
1919
- Drivers and converters should avoid exposing "implementation detail". This includes things such as actual block and item ids, for example.
2020
- If there is an upgrade for it, don't write a driver for it. If you're up to it, adjust the upgrade to work in the adapter, otherwise let me know and I'll have a look.
2121

22-
When in doubt, ask on the IRC or open an issue to discuss the driver you'd like to add!
22+
When in doubt, ask on the IRC or open an issue to discuss the driver you'd like to add!

0 commit comments

Comments
 (0)