https://github.com/zabackary/vexmason-template
A template to use to get started with vexmason, the bundler that lets you write for V5 with Python modules, compile-time variables, and other idioms used in real Python projects.
https://github.com/zabackary/vexmason-template
vex vex-python vex-robotics vex-robotics-competition vex-v5 vexcode vexmason
Last synced: 5 months ago
JSON representation
A template to use to get started with vexmason, the bundler that lets you write for V5 with Python modules, compile-time variables, and other idioms used in real Python projects.
- Host: GitHub
- URL: https://github.com/zabackary/vexmason-template
- Owner: zabackary
- Created: 2024-02-27T13:19:14.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-19T11:48:13.000Z (9 months ago)
- Last Synced: 2024-11-24T06:15:32.180Z (7 months ago)
- Topics: vex, vex-python, vex-robotics, vex-robotics-competition, vex-v5, vexcode, vexmason
- Language: Python
- Homepage:
- Size: 9.77 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# vexmason template repository
Simply click "Use this Template" to get started with
[vexmason](https://github.com/zabackary/vexmason), the VEX V5 Python bundler
that Just Works(r).
vexmason is a bundler that allows you to write modern, OOP, abstract Python code
and yet still use the VEXCode V5 build/upload tools maintained by VEX.
Feel free to modify this setup to your needs, but the code here is roughly the
same as my team is using in production. We are using a custom drivetrain
implementation and a cool UI as well as some other fancy things which I'll
consider open-sourcing later this year, but this is a good basic setup (I think)
which is pretty "clean" - all the code is in different modules and lots of OOP
paradigms. Good luck with your team!
My hope is this setup will help illustrate how real complex codebases are
organized into modules. If you're up for a challenge, implement a route
selection UI (user interface, i.e. buttons on a screen) like I did. I'm not
perfect and
[we life in a sinful, fallen world](https://www.biblegateway.com/passage/?search=Romans%205%3A8),
so if there's anything that needs to be improved, please let me know! I'm
looking for feedback.
## Setup
- `.vscode/vexmason-config.json`
This contains the program name, description and defines.
- `.vscode/vexmason-local-config.json`
This file is gitignored, but you should use
[`vexmason-local-config.example.json`](./.vscode/vexmason-local-config.example.json)
as an example to get started. It contains the computer name (which you can use
as a placeholder in the description like this: `{{ computer-name }}`) and the
local defines overrides.
- `src/`
This is where your code lives! I have some things there already, but please
modify it to suit your setup.
## Support
If you run into any problems while compiling (i.e., an error popup saying VEX
Error in the bottom right of your screen), make sure to check
[`build/vexmason.log`](./build/vexmason.log) to see if there's any useful logs.
If you can't figure it out, leave a
[GitHub issue](https://github.com/zabackary/vexmason-template/issues/new) and
I'll get back to you soon.
## Small personal note
(feel free to ignore this)
Maybe you've heard the story of Jesus
or have heard the name, but there are still _so_ many people who haven't heard
the "Good News", or the gospel of Christianity. Whether you're Christian or not,
I urge you to find out that God's love for you, even through all your mistakes
and failures both with robotics and with life, was large enough that He died for
you to bring you back into a loving relationship with Him.