-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from olin/add-proposal
Add project proposal
- Loading branch information
Showing
1 changed file
with
68 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| # COLLASCII | ||
|
|
||
| _A collaborative ascii canvas_ | ||
|
|
||
| Team members: | ||
| [Matthew Beaudouin-Lafon](https://github.com/MatthewBeaudouinLafon), | ||
| [Evan New-Schmidt](https://github.com/newsch/) | ||
|
|
||
| ## Project Goal | ||
|
|
||
| Our goal is to make a collaborative ascii drawing application, through a terminal interface. Think of it like the google docs of [asciiflow](http://asciiflow.com/), but in a terminal. | ||
| Why? Because it's funny, questionable, and a little bit artsy. Oh and a great learning experience too. | ||
|
|
||
| ### MVP | ||
|
|
||
| The MVP is designed to be a relatively low bar to ensure we get to a good place. | ||
| - An editor where you move with arrow keys and press a character to change a cell. | ||
| - A client/server model that allows other people to connect to and edit your instance, given an IP and port. | ||
| - Featuring a status bar a la vim. | ||
|
|
||
| ### Additional Features (ordered by priority) | ||
|
|
||
| This list of features is designed such that no matter where we stop, we'll be happy with what we have. | ||
| - Different modes to support more features (eg. box mode) | ||
| - Drawing straight lines | ||
| - Drawing boxes | ||
| - Free line (move cursor and choose best ascii character to make a "smooth" line) | ||
| - Fill with character (paint bucket) | ||
| - panning across larger canvases | ||
| - an r/theplace | ||
| - layers, bringing it closer still to industry standards like Photoshop™ | ||
| - mouse support (`ncurses` supposedly makes this easier) | ||
| - colors | ||
| - Interactive tic-tac-toe with a physical device | ||
| - draw lines, move cursor to one of 9 places, draw whole X or O | ||
| - Enter Tic-Tac-Toe mode by drawing board? | ||
| - Importing images as ascii | ||
|
|
||
| ## Learning Goals | ||
|
|
||
| ### Evan | ||
|
|
||
| I'd like to work with 3rd-party libraries, implement a concurrent networked program, and learn how to write a terminal interface. I'm looking forward to writing thoughtful APIs that are used in multiple ways, and above all else I want to create something that people will enjoy using. | ||
|
|
||
| ### Matt | ||
|
|
||
| I'm shooting for a project that says "Look I can write C, but not for important things". Learning goals include writing good apis, writing good C, designing a decent CLI, and learning about networking hands on. | ||
|
|
||
| ## What's Needed | ||
|
|
||
| Going forward, there are two main unknowns for us: creating an interactive editor, and implementing a concurrent network protocol for connections between clients. Some resources that we've found for each are listed below: | ||
| - text editor (of sorts) for drawing and displaying the canvas | ||
| - [this project](https://github.com/SelinaWang/SoftSysZis/blob/master/reports/report.md) built a text editor following [this guide](https://viewsourcecode.org/snaptoken/kilo/index.html) (they **did not** use `ncurses`) | ||
| - [this project](https://github.com/vickymmcd/SillyString/blob/master/reports/report.md) used `ncurses` to build an interactive escape the room game and found [NCURSES introduction](https://invisible-island.net/ncurses/ncurses-intro.html) and [NCURSES tutorial](http://tldp.org/HOWTO/NCURSES-Programming-HOWTO/) useful. | ||
| - [this tutorial](https://cheukyin699.github.io/tutorial/c++/2015/02/01/ncurses-editor-tutorial-01.html) covers creating a text-editor in `ncurses` with C++ | ||
| - a network protocol for sending updates to the canvas between users | ||
| - Right now my inclination is to work with an HTTP/[ARPA Internet Text Messages](https://tools.ietf.org/html/rfc822) related format over TCP, and go from there. | ||
| - [this project](https://github.com/shrutiyer/SoftSysServerClient/blob/master/reports/report.md) implemented a client/server for a chat room | ||
| - [Beej's Guide to Network Programming has a section on synchronous connections](https://beej.us/guide/bgnet/html/multi/advanced.html) | ||
| - Head First C has some chapters on networking (11 and 12) that discuss `fork`ing and multiple clients | ||
|
|
||
| ## First Steps | ||
|
|
||
| - Evan: Read Chapters 11 (Sockets and Networking) and 12 (Threads) of HFC for more info on networking in C. _Done when they're read and a written summary is commented in Trello._ | ||
| - Evan: Write a spec and implementation of a single-threaded server/client that can send an ascii canvas back and forth. _Done when a pull-request with the code is approved and merged._ | ||
| - Matt: Go through ncurses tutorials above. _Done when they're read and a written summary is commented in Trello._ | ||
| - Matt: Write spec for Terminal UI _Done when pull request is merged_ | ||
| - Matt: sketch ncurses implementation. _Done when checked and pull request is merged_ |