jewbird
/
asciibird
3
3
Fork 0
Code Issues Pull Requests Releases Activity
asciibird/README.md

8.0 KiB
Raw Blame History

ASCIIBIRD

                           ┏   ┰╛    ╔═━┉┈┉╼━━╌┈╍┅┉╌┄┉┉━═╾─┈═──┄┈╼╍═┈┄╍═╍╼━┈─┈╼┉╍┅╌╮
                         ╘███╏████╒█ ┕█   http://jewbird.live/                     ╏
                            █┻█  █┦█  █╕  http://yt.jewbird.live/                  ┇
                          ╔╼█ ████ ████╚━ http://patreon.jewbird.live/             ┃
                         ╕  █ █ █┉╍█ ┌█═  http://streamlabs.jewbird.live/          ╽
                       ━█████ █ ██ █ ╯█   ASCIIBIRD TAKING FLIGHT                  ╎
                          ┸╮    ╛     ╘╼┈┅┅──━┈┉┅┈╍┄┈┄┈╍┉╾╾╼╍═━╾╾┄╼╾═─┈═┉═╼┅─┈━╌╾╾┅╯

                              [BTC] 1L2u8mQs5pe7k11ozn2BgX388e3fGMD7qo
[XMR] 832owKc3ZuGCnmjHXHeZeeJzGAxyKx5uWU9WxoaXg6BhQ7aWSnZ6EhxFK8Mzw137nSgGAfMM8FgHjM6rpq5s1EofD7UT2yp
           [STREAMLABS] http://streamlabs.jewbird.live [PATREON] http://patreon.jewbird.live
     [YT] http://yt.jewbird.live [TWITCH] http://twitch.jewbird.live [GITHUB] http://git.jewbird.live

ASCIIBIRD is an IRC ascii art editor to create or edit mIRC art, it is most times worked on during live stream. It's 100% client side and created in vue2 and may be migrated to vue3 in the future.

You can view and load ASCII art from https://irc.watch/ascii into asciibird.

A most latest production build to use is available at https://asciibird.jewbird.live/

Big Shout outs to Patrons

beenz, xartet, OfMonsters&Crime, mouse, funkpower, Charles, PP4L, octopus, addct, hotline, dingopride, skg, eraser, aaa, chz, L0j1k

Current Features

  • Tabbed ASCII editing
  • Layers support
    • Show and hide layers
    • Change layer order
    • Double click to rename layer
    • Context menu for layers
  • Copy and paste ASCII blocks between tabs with the select tool
  • Remembers state on refresh and when the browser loads, can also export the state to a file and load elsewhere.
    • So you never lose your ascii art!
    • Saves layers, brushes data also to same file
  • Can import from clipboard, load from irc.watch/ascii, load from file
  • Can export mirc ascii to clipboard, file or HTTP POST
  • 99 Colour support
  • Swap fg and bg colours with button click or Alt + r
  • Mirror X and Y
  • Grid mode with Alt + g
  • Undo and redo with Ctrl + z and Ctrl + y, undos are set to a limit of 200 at the moment.
  • Fg, Bg and Char boxes to filter when using certain tools
    • For example filling with Char unchecked will ignore characters when filling
    • If you want to remove the background but keep the text, unchek FG and Char and eraser the bg only.
  • Image overlay to trace images
  • Accepts URLs only at the moment
  • Can adjust the size and properties
  • Toolbar containing
    • Select, to copy and paste blocks as brushes
    • Text mode, with arrow key support
    • Fill background blocks
    • Brush mode, can be controlled with keyboard and mouse
    • Block picker (grab fg, bg and char of a block)
    • Eraser - remove blocks, can be controlled with keyboard and mouse
    • Fill Eraser - Fill remove blocks by bg, fg or char
  • Brush Library and History
    • Make circle, square, cross and other brushes by sizes
    • Brush history, can save or re-use old brushes
    • Library - Save most used brushes to library
    • Brush history is set to a limit of 50
  • Brush Preview
    • Editable brush preview
    • Clicking updates block
    • Right clicking removes block
    • Hovering outside brush area will save brush to history
  • Context menu available on all brushes preview areas
  • Export any brush to PNG, mIRC clipboard or file by right clicking the brush preview

Roadmap and Bug To Fixes

Features to Add

  • While select works fine, it could be improved.
  • Layers undo and redo could be implemented, at the moment there isn't any.
  • Warning on mirc export if ascii exceeds IRCs 512 per chat line limit.
  • Review encodings check on file import - UTF8 vs Latin something

Bugs to fix

  • The edit dialog, even when code to save new data is commented out, will slow down everything if you open and save the modal a few times

Mobile / Touch Screen support

Doesn't exist at the moment. While the underlying functions and code is compatible with mobile browsers from babel, the touch canvas events and text will need to be reviewed to work better with touch screens. For example while you can brush once, you cannot move the brush around.

Keyboard Shortcuts

ASCII Editing

  • Ctrl + Z - Undo

  • Ctrl + Y - Redo

  • Escape - Return to default mode, stop using any tool and close fg, bg and char panels.

  • Alt 1 to 8 - Will toggle the corresponding toolbar icon

  • Alt + c - Opens character Panel (You can then press on the keyboard your desired character or select from the list)

  • Alt + f - Opens foreground panel (can then press 0 to 9 for the colour)

  • Alt + b - Opens background panel (can then press 0 to 9 for the colour)

  • Alt + g - Toggle grid mode

  • Ctrl + ] - Increase both brush sizes by 1 (brush or eraser mode only)

  • Ctrl + [ - Decrease both brush sizes by 1 (brush or eraser mode only)

  • Alt + x - Toggle Mirror X

  • Alt + y - Toggle Mirror Y

  • Alt + u - Toggle Update Brush (change brush preview if fg, bg or char changes)

  • Alt + r - Flip FG and BG colours

  • Ctrl + e - Edit ASCII

  • Ctrl + q - Close ASCII

  • Ctrl + m - New ASCII (can't use ctrl + n)

  • Ctrl + o - Toggle Asciibird Options

Importing

  • Ctrl + Shift + o - Open mIRC TXT File as new Ascii
  • Ctrl + Shift + v - Paste New Ascii

Exporting

  • Ctrl + Shift + C - Copy to clipboard
  • Ctrl + Shift + F - Save to TXT file
  • Ctrl + Shift + G - Save to PNG file
  • Ctrl + Shift + H - Save to HTTP Post

Showing / Hiding menus, tabs and panels

  • Ctrl + Alt + t - Hide / Show Tabs
  • Ctrl + Alt + m - Hide / Show Menu
  • Ctrl + Alt + d - Hide / Show Debug Panel
  • Ctrl + Alt + b - Hide / Show Brush Library
  • Ctrl + Alt + l - Hide / Show Layers
  • Ctrl + Alt + n - Hide / Show Toolbar
  • Ctrl + Alt + e - Hide / Show Brush Preview

Select Mode

  • Ctrl + c - Copy blocks to clipboard
  • Ctrl + x - Cut blocks to clipboard
  • Ctrl + v - Paste blocks as brush
  • Delete - Delete selected blocks

Eraser Mode

  • Four arrow keys control text cursor
  • Space - apply eraser

Brush Mode

  • Four arrow keys control text cursor
  • Space - apply brush
  • e - rotate brush
  • q - flip brush

Text mode

  • Four arrow keys control text cursor
  • Delete - Remove text from highlighted block
  • Backspace - Remove current character and move to previous block
  • Enter - Go to next line and reset X position to 0

Layers Related

  • Ctrl + Shift + t - Show / Hide Layer
  • Ctrl + Shift + r - Rename Layer
  • Ctrl + Shift + a - Add Layer
  • Ctrl + Shift + d - Delete Layer
  • Ctrl + Shift + s - Move Layer Down
  • Ctrl + Shift + w - Move Layer Up
  • Ctrl + Shift + m - Merge All Layers

References

Project setup

yarn

Compiles and hot-reloads for development

yarn serve

Compiles and minifies for production

yarn build

Lints and fixes files

yarn lint

Customize configuration

See Configuration Reference.