Git Product home page Git Product logo

debateapp's Introduction

DebateApp

It's an app ... for debate. OK, more specifically it is a combination digital flow creator and timer for PF, LD, and policy debate

Getting Started

Prerequisites

These requirements only apply if you want to build from source or use the jar file

* JDK 11 (including JavaFX)
* Maven

Installing

Sorry about any security prompts, code signing certificates are expensive

MacOS

  1. Download the macOS installer
  2. Open it
  3. Drag DebateApp into your applications folder

If you see any warnings about the app being unverified, see this help page

Windows

  1. Download the Windows installer
  2. Just run the installer, it will create a Start Menu entry that will run the program

Ubuntu

  1. Download the .DEB installer
  2. Run or extract it

Other Linux distros

  1. Download the .tar.gz archive marked for linux
  2. Extract the archive
  3. Move the folder to your preferred install location
  4. (optional) Create a desktop shortcut

Extractable archives are also provided for each OS for manual installation

Features

  • Support for PF, LD, and Policy
  • Flow editors for every speech
  • Rich text editing
  • Customizable timers for every speech and for prep (Defaults to NSDA standards)
  • Quick swapping via keybind between "pages"
  • Multiple layouts for your flows
  • Save your flow as a custom .db8 file so you can come back to it later
  • Export your flow to a word document, one large PNG, a PNG for every speech, or a multi-page TIFF
  • Set as always on top if you have multiple windows open
  • Links to a number of helpful debate-related sites (including r/Debate)
  • Automatic update checker
  • Easy installer for Windows, macOS, and now for Linux

Using the app

Choose an event

  1. Click "Event" in the menu
  2. Click next event until you have reached your preferred event

To always open the app to a certain event, change "Default Event" in settings

Save your flow

  1. Either press ctrl/cmd+s or click save in the File menu
  2. Select a file to save and click OK

Open a previously saved flow

  1. Either press ctrl/cmd+o or click open in the File menu
  2. Select the file to open

--- Or ---

Open the file by double-clicking, DebateApp should automatically associate .db8 with DebateApp

... but if it doesn't follow the instructions for your OS:

Switching layouts

Select your preferred layout under View

Disabling the toolbars on the editors

If you find the editor toolbars distracting, or unnecessary, they can be disabled in settings

Make DebateApp always on top

In the view menu, select "always on top"

Known issues

  • If you have multiple monitors with different DPI configurations, menus may open in odd locations. There is nothing I can do about this, it's a bug in JavaFX not DebateApp.
  • Aggressive anti-viruses (e.g. Avast, or macOS Gatekeeper) usually throw a warning about unsigned code
    • Solution: after the first scan most AVs will ignore DebateApp, if they don't simply mark the DebateApp exe as excluded

Built With

Building from source

  1. Clone the repository
  2. Run mvn clean compile
  3. Execute main.java.DebateAppMain

Versioning

I use SemVer for versioning. For the versions available, see the tags for this repository.

Author

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details

Acknowledgments

  • ControlsFX just has some really useful pre-coded controls that saved a lot of time in this project
  • JMetro provides native look and feel to the windows version
  • Freepik created some icons that were used in the app
  • Anyone whose mac I borrowed to test compatibility

debateapp's People

Contributors

jthoward64 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.