pasek108 / befunge93interpreter

BeFunge 93 interpreter with grid visualisation, debugging tools and nyan cats animations

BeFunge 93 IDE Readme

❓Why my commits often have no names and I'm not using branches❓

• I often create with bursts many things at once
• I don't plan things ahead, I just create things that seems good at that moment
• Sometimes I have bad internet connection and it is troublesome to send commits
• I'm coding alone so creating branches and describing commits is not useful for me

Table of Contents

• Informations
  • Technologies
  • Features
  • Setup
  • Acknowledgements
• Details
  • User interface
  • Project structure
  • Code organization

Informations

Befunge 93 interpreter with visualization on grid, debugger and nyan cats pixel animations.
See live demo.

---

Technologies

Languages:

• HTML5
• CSS3
• JS ES2018

Libraries and frameworks:

• LESS
• FontAwesome 6.4.0
• GoogleFonts

Programs:

• VSCode
• Prepros (auto preview, processing less)

---

Features

• Interpretation of given code program
• Visualisation of program in grid, stack and interactive console
• Program controls (load, execute, run, step, stop)
• Breakpoints that pause program execution
• Information about language and exapmle programs
• Table with instructions
• Settings:
  • Speed
  • Pointer and breakpoint color
  • Grid lines visibility
• Nyan cats animations:
  • Defualt nyan cat
  • Gameboy nyan cat
  • Rasta nyan cat
  • Christmas nyan cat
  • Mexican nyan cat
• Multiple languages:
  • Polish
  • English

Note

Room for improvements:

• Instruction how to use the program
• Unlimited program grid size
• Editing program on the grid
• Zooming grid in and out
• Skipping over empty cells
• Hilighting program path
• Execution that is not blocking the webiste
• Faster execution

---

Setup

Ways to run this program:

1. Use the live demo
2. Download this repo and run index.html file
3. Download this repo and start live server (VSCode LiveServer Extension, Prepros preview etc.)

To edit this program:

• Download this repo
• Install Prepros
• Add this project in Prepros
• Start coding

---

Acknowledgements

• Befunge - esolangs wiki
• Befunge 93 documentation
• mikescher Project Euler with Befunge
• qiao visual befunge93 interpreter
• jsFunge IDE
• bedroomlan - befunge playground

Details

This section is a general description of the project required to understand how it works, the exact details are in the code or simply are the code.

User interface

Main menu

---

Main menu

---

Project structure

The project directory tree looks like this:

• 📁 TicTacToe (project folder)
  • 📄 github and prepros config
  • 📄 readme file
  • 📄 index.html file
  • 📁 _for_readme - 📄 files for readme
  • 📁 language
    • 📁 en - 📄 files for english language
    • 📁 pl - 📄 files for polish language
  • 📁 nyan_cats
    • 📄 nyan cat icon
    • 📁 default - 📄 files for default nyan cat
    • 📁 gameboy - 📄 files for gameboy nyan cat
    • 📁 rasta - 📄 files for rasta nyan cat
    • 📁 christmas - 📄 files for christmas nyan cat
    • 📁 mexican - 📄 files for mexican nyan cat
  • 📁 js - 📄 scripts used in the project
  • 📁 css
    • 📄 css files compiled by prepros
    • 📁 less - 📄 less files

---

Code organization

Warning

Classes must be loaded from bottom to the top to avoid situation when class does not exist in the time of its objects creation

Menu is entry of the program.

Menu creates and manages one instance of each of the classes:

• MenuWindow (Credits)
• Difficulty
• TopScore
• Game

Difficulty and TopScore classes are extension of MenuWindow class which is responsible for showing and hiding menu window with transition

Game class creates and manages:

• One instance of RoadBackground class
• Two instances of treesBackground class (left and right side)
• One instance of classes:
  • HealthBar
  • EnergyBar
  • PointsCounter
  • GameOver
• One instance of Player class
• Many instances of classes:
  • Enemy
  • Deer
  • HappyDeer