From a3608492fb1728e7ad52364fd1fb764e33c72226 Mon Sep 17 00:00:00 2001 From: "Brian S. Stephan" Date: Thu, 24 Aug 2023 19:51:07 -0500 Subject: [PATCH] considerably more README documentation --- README.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 58 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7903940..77d8c63 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,64 @@ # Bullet System Stick -Files for making an arcade stick. +Files for 3D printing an arcade stick. -These files are suitable for previewing and rendering in OpenSCAD. +Originally an attempt to make a couple customized STL files for the [OpenStickCommunity Fightstick +Case](https://github.com/OpenStickCommunity/Hardware/tree/main/Fightstick%20Case), the changes ballooned to fit my +design and became incompatible with that project's components. This should be considered a different project with some +similar DNA, but to stress again, it could not have been done without that project as a guide star. See **Attribution**. + +## Designing + +No particular arcade stick design is prescribed by this project, instead, SCAD files are provided to choose desired +component objects or create new ones. The OpenSCAD language is essentially a functional programming language, making it +it easy to reuse, alter, and compose objects. If you do not see the object you would like, you can likely create it by +starting with an existing object and constructing what you'd like with new or existing components. + +## Printing + +These items all fit on a 256mm^2 print bed; I use a Bambu Lab P1P based on what I've learned from the +OpenStickCommunity. Standard settings seem sufficiently sturdy for my purposes, though the slicer has done a couple +weird things, in my experience. + +## Assembling + +What you'll need beyond these objects: + +* An arcade stick board (I recommend [TheTrain's RP2040 Advanced Breakout + Board](https://github.com/OpenStickCommunity/Hardware/tree/main/RP2040%20Advanced%20Breakout%20Board)) + * 4 M3 8mm hex bolts to secure the PCB to a panel +* Per frame and plate combo: + * 4 40mm M4 hex brass standoffs + * 8 12-16mm M4 countersunk hex bolts +* Per frame connection point: + * 8 25mm M4 bolts + * 8 M4 flange nuts +* For a lever: + * 4 12-16mm M4 countersunk hex bolts + * 4 M4 flange nuts +* Buttons and levers as desired +* Wiring as required + +### Issues and Limitations + +This is a living repository, and as such, there are likely issues with the objects, known or otherwise. Be aware: + +* The top panel is 5mm tall and doesn't have an inset; snap-in buttons likely do not fit. +* A composition error made the frame 5mm shorter than intended and wasn't noticed until I printed everything: + * Some levers don't have enough clearance in the case. + * Buttons with traditional quick connects are a *very* tight fit, you will probably need to bend pins. +* The PCB mount position was very tight on the buttons panel; it will probably have to be moved. +* Support for the top plate was removed from the frame due to overhang issues, and now the top plate can bow slightly + with pressure; a new solution needs to be found. + +These issues may be fixed in the future; see `TODO.md` for details. + +## Development and Contributing + +Improvements, variants, new layouts, novel ideas, and etc. are all welcome. + +These files are suitable for previewing and rendering in OpenSCAD. They may also work in FreeCAD and perhaps other +software, but they are developed in OpenSCAD, so YMMV otherwise. ## Attribution