Skip to content

Commit 02399f3

Browse files
committed
pass over readme and clarification on change of library culture
1 parent 2861381 commit 02399f3

1 file changed

Lines changed: 10 additions & 14 deletions

File tree

readme.md

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -44,15 +44,13 @@ See [below](#export-globals) for a discussion of the pros and cons of `export`.
4444

4545
# Library Culture and Contributing
4646

47-
`batteries` aims to be approachable to almost everyone, but I _do_ expect you to get your hands dirty. I'm very open to collaboration, and happy to talk through issues or shortcomings in good faith.
47+
`batteries` aims to be approachable to almost everyone writing lua, but I _do_ expect you to get your hands dirty, which includes reading the source for docs.
4848

49-
Pull requests are welcome for anything - positive changes will be merged optimistically, and I'm happy to work with you to get anything sensible ready for inclusion.
49+
As of 2026 my time is much more limited and I'm less able to accept pull requests and less open to direct collaboration. You're welcome to fork, and I'm not completely closed to collaboration, but I'm not going to optimistically merge things at this time.
5050

51-
If you have something "big" to contribute _please_ get in touch before starting work so we can make sure it fits. I'm quite open minded!
51+
`batteries` is moving on a more personal trajectory, and I am also considering reverting some changes that haven't sat all that well with me for years. Any changes will be balanced against community impact, as I know the library has started to be used more widely, but I'm not going to just ignore my own opinions either.
5252

53-
If you've had a good look for the answer but something remains unclear, raise an issue and I'll address it. If you _haven't_ had a good look for the answer, checking the source _always_ helps!
54-
55-
If you'd prefer to talk with me about `batteries` in real time, I'm often available on the love2d discord.
53+
If you'd like to talk with me about `batteries` in real time, I'm often available on the love2d discord.
5654

5755
# Module Overview
5856

@@ -83,15 +81,15 @@ General utility data structures and algorithms to speed you along your way.
8381
Modules to help work with spatial concepts.
8482

8583
- [`intersect`](./intersect.lua) - 2d intersection routines, a bit sparse at the moment.
86-
- [`vec2`](./vec2.lua) - 2d vectors with method chaining, and garbage saving modifying operations. A bit of a mouthful at times, but you get used to it. (there's an issue discussing future solutions).
87-
- [`vec3`](./vec3.lua) - 3d vectors as above.
84+
- [`vec2`](./vec2.lua) - 2d vectors with method chaining, and garbage saving modifying operations. A bit of a mouthful at times, but you get used to it.
85+
- [`vec3`](./vec3.lua) - 3d vectors as above, less mature.
8886

8987
**Special Interest:**
9088

9189
These modules are probably only useful to some folks in some circumstances, or are under-polished for one reason or another.
9290

93-
- [`async`](./async.lua) - Asynchronous/"Background" task management.
94-
- [`colour`](./colour.lua) - Colour conversion routines. Alias `color`.
91+
- [`async`](./async.lua) - Asynchronous/"Background" task management. Basically convenience around lua coroutines.
92+
- [`colour`](./colour.lua) - Colour conversion and encoding routines. Alias `color`.
9593
- [`manual_gc`](./manual_gc.lua) - Get GC out of your update/draw calls. Useful when trying to get accurate profiling information; moves "randomness" of GC. Requires you to think a bit about your garbage budgets though.
9694
- [`measure`](./measure.lua) - Benchmarking helpers - measure the time or memory taken to run some code.
9795
- [`make_pooled`](./make_pooled.lua) - add pooling/recycling capability to a class
@@ -113,11 +111,9 @@ Endless, of course :)
113111
- `delta` - Detect and sync changes to objects.
114112
- Broadphase:
115113
- Spatial simplification systems for different needs. Probably AABB or point insertion of data.
116-
- `bucket_grid` - Dumb 2d bucket broadphase.
114+
- `bucket_grid` or `spatial_hash` - Simple 2d bucket broadphase.
117115
- `sweep_and_prune` - Popular for bullet hell games.
118116
- `quadtree`/`octree` - Everyone's favourite ;)
119-
- UI
120-
- Maybe adopt [partner](https://github.com/1bardesign/partner) in here, or something evolved from it.
121117
- Image
122118
- Maybe adopt [chromatic](https://github.com/1bardesign/chromatic) in here, or something evolved from it.
123119

@@ -135,7 +131,7 @@ You can, of course, use the separate modules on their own, either requiring indi
135131

136132
I'd strongly recommend that if you find yourself frustrated with the above, stop and think why/if you really want to avoid globals for something intended to be commonly used across your entire codebase! Are you explicitly `require`ing `math` and `table` everywhere you use it too? Are you just as ideologically opposed to `require` being a global?
137133

138-
You may wish to reconsider, and save yourself typing `batteries` a few hundred times :)
134+
You may wish to reconsider, and save yourself typing `batteries` many, many times :)
139135

140136
## Git Submodule or Static Install?
141137

0 commit comments

Comments
 (0)