Skip to content

Latest commit

 

History

History
114 lines (83 loc) · 7.26 KB

README.md

File metadata and controls

114 lines (83 loc) · 7.26 KB
Raw

TWANG (FORK)

An Arduino-based, 1D, LED loving, dungeon crawler. inspired by Line Wobbler by Robin B

This fork is focused on the porting to the smaller ATmega328p, means this version is running on a Arduino NANO with up to 288 LEDs!

Features:

  • More levels. Merged levels from other forks, now you have 20 levels to beat!
  • More screensavers. Also merged from other forks, 5 different patterns total
  • More settings to configure in the serial menu to adopt it to a new location
  • Works on extremely cheap Arduino NANO clones with all features
  • Only 75% of flash is used on the NANO so there is lots of room for more levels and screensavers (please share them via pull requests)

Required libraries:

Hardware used:

  • Arduino NANO or MEGA
  • 3 LEDs for life indicator (optional) This fork displays the remaining lives on the LED strip.
  • LED light strip. NANO is limited to max. 288 LEDs, MEGA up to 1000
    • 1 meter 60 LEDs (good)
    • 1 meter 144 LEDs. (awesome. Great for running on table, very portable)
    • 2 meter 288 LEDs. (awesome. The increased resolution makes the game a little easier to win)
    • 3 meter 180 LEDs. (fun. Great for balcony or running from a table up to the wall)
    • 5 meter 450 LEDs. (awesome, but too long for most locations, only with MEGA)
    • Virtually tested 1000. The game slows down at this count on Arduino (great on ESP32 see other forks)
  • MPU6050 accelerometer
  • Spring doorstop, I used these

Connection for Arduino Nano

Arduino Nano:   Connect to:
Pin  D2         LED data pin
Pin  D3         LED clock pin (not used for WS2812)
Pins D5 & 6 & 7 Life LEDs
Pins D9 & 10    Loudspeaker (Connect a 100 to 200 Ohm resistor in series to one pin)
Pin  A4         Gyroscope SDA
Pin  A5         Gyroscope SCL
Pin  Vin        Voltage input from LED power supply
Pin  5V         Voltage output to gyroscope
Pin  GND        Ground from power supply and to gyroscope

Enclosure

Files to print the original enclosure and controller knob can be found here The Tindie kit version version of the enclosure can be found here

Overview

The following is a quick overview of the code to help you understand and tweak the game to your needs.

The game is played on a 1000 unit line, the position of enemies, the player, lava etc range from 0 to 1000 and the LEDs that represent them are derived using the getLED() function. You don't need to worry about this but it's good to know for things like the width of the attack and player max move speed. Regardles of the number of LEDs, everything takes place in this 1000 unit wide line.

LED SETUP Defines the quantity of LEDs as well as the data and clock pins used. I've tested several APA102-C strips and the color order sometimes changes from BGR to GBR, if the player is not blue, the exit green and the enemies red, this is the bit you want to change. Brightness should range from 50 to 255, use a lower number if playing at night or wanting to use a smaller power supply. "DIRECTION" can be set to 0 or 1 to flip the game orientation. In setup() there is a "FastLED.addLeds()" line, in there you could change it to another brand of LED strip like the cheaper WS2812.

The game also has 3 regular LEDs for life indicators (the player gets 3 lives which reset each time they level up). The pins for these LEDs are stored in lifeLEDs[] and are updated in the updateLives() function

JOYSTICK SETUP All parameters are commented in the code, you can set it to work in both forward/backward as well as side-to-side mode by changing JOYSTICK_ORIENTATION. Adjust the ATTACK_THRESHOLD if the "Twaning" is overly sensitive and the JOYSTICK_DEADZONE if the player slowly drifts when there is no input (because it's hard to get the MPU6050 dead level)

WOBBLE ATTACK Sets the width, duration (ms) of the attack

POOLS These are the object pools for enemies, particles, lava, conveyors etc. You can modify the quanity of any of them if your levels use more or if you want to save some memory, just remember to update the respective counts to avoid errors.

USE_GRAVITY 0/1 to set if particles created by the player getting killed should fall towards the start point, the BEND_POINT variable can be set to mark the point at which the strip of LEDs goes from been horizontal to vertical. The game is 1000 units wide (regardless of number of LED's) so 500 would be the mid point. If this is confusing just set USE_GRAVITY to 0

Serial Port Options Menu (New!)

All of the basic setup options can now be set over the serial port. An easy to use serial terminal is the Serial Console of the Arduino IDE. Open the Com Port that appears when you plug in the TWANG USB.

Set it up for 115200 baud and have it add a carriage return when sending. You should see this menu.

You can change any of these settings. Send B=225 to change the LED brightness to 225 (on a 5-255 scale). These settings will be saved in the EEPROM memory of the TWANG and not be lost when you power down the TWANG.

There are also 3 single character commands (?, R, !)

Modifying / Creating levels

Find the loadLevel() function, in there you can see a switch statment with the 20 levels currently implemented. They all call different functions and variables to setup the level. Each one is described below:

playerPosition; Where the player starts on the 0 to 1000 line. If not set it defaults to 0. I set it to 200 in the first level so the player can see movement even if the first action they take is to push the joystick left

spawnEnemy(position, direction, speed, wobble); (10 enemies max)

  • position: 0 to 1000
  • direction: 0/1, initial direction of travel
  • speed: >=0, speed of the enemy, remember the game is 1000 wide and runs at 60fps. I recommend between 1 and 4
  • wobble: 0=regular moving enemy, 1=sine wave enemy, in this case speed sets the width of the wave

spawnPool[poolNumber].Spawn(position, rate, speed, direction); (2 spawners max)

  • A spawn pool is a point which spawns enemies forever
  • position: 0 to 1000
  • rate: milliseconds between spawns, 1000 = 1 second
  • speed: speed of the enemis it spawns
  • direction: 0=towards start, 1=away from start

spawnLava(startPoint, endPoint, ontime, offtime, offset); (4 lava pools max)

  • startPoint: 0 to 1000
  • endPoint: 0 to 1000, combined with startPoint this sets the location and size of the lava
  • ontime: How long (ms) the lava is ON for
  • offtime: How long the lava is ON for
  • offset: How long (ms) after the level starts before the lava turns on, use this to create patterns with multiple lavas

spawnConveyor(startPoint, endPoint, speed); (2 conveyors max)

  • startPoint, endPoint: Same as lava
  • speed: The direction and speed of the travel. Negative moves to base and positive moves towards exit. Must be less than +/- max player speed.

spawnBoss(); (only one, don't edit boss level)

  • There are no parameters for a boss, they always spawn in the same place and have 3 lives. Tweak the values of Boss.h to modify