NodesNim/README.md

Nodesnim

The Nim GUI/2D framework based on OpenGL and SDL2.

Latest version - 0.0.3

Stable version - 0.0.2

Install

1. Install this repo
   • nimble install nodesnim or nimble install https://github.com/Ethosa/nodesnim.git
2. Download OpenGL, SDL2_image, SDL2_mixer and freeglut Runtime binaries for your OS
   • SDL2
   • SDL2_image
   • SDL2_mixer
3. Put Runtime binaries in the .nimble/bin/ folder

Features

• Godot-like node system.
• Simple usage ```nim import nodesnim

Window("Hello, world!")

var

scene_obj: SceneObj
scene = Scene("Main", scene_obj)
label_obj: LabelObj
hello = Label(label_obj)

hello.setText("Hello, world!") hello.setSizeAnchor(1, 1) hello.setTextAlign(0.5, 0.5, 0.5, 0.5) scene.addChild(hello)

addMainScene(scene) windowLaunch() ```

Now available

• Core
  • Anchor
  • Color
  • ColorText
  • Enums
  • Exceptions
  • Image
  • Input
  • Rect2
  • Vector2
  • Circle2
  • Polygon2
  • AudioStream
  • Animation
• Default nodes
  • Node
  • Canvas
  • Scene
  • AudioStreamPlayer
• Control nodes
  • Control
  • ColorRect
  • TextureRect
  • Label
  • Button
  • EditText
  • RichLabel
  • RichEditText
  • Box
  • HBox
  • VBox
  • GridBox
  • Scroll
  • ProgressBar
  • Slider
  • VProgressBar
  • VSlider
  • Popup
  • TextureButton
  • TextureProgressBar
  • Counter
  • Switch
• 2D nodes
  • Node2D
  • Sprite
  • AnimatedSprite
  • YSort
  • CollisionShape2D
  • KinematicBody2D

Debug mode

For use debug mode you should compile with -d:debug or --define:debug, e.g. nim c -r -d:debug main.nim.

Export

Use the Nim compiler user guide for export to the other OS.

• CrossPlatform export for Windows (tested on Windows 7 x64 and Windows 10 x64)
  • nim c -d:mingw -d:release --opt:speed --noNimblePath file.nim
  • put Runtime binaries in the folder with the program.

F.A.Q

Q: Where can I see examples?
A: You can see this in the tests or examples folder.

Q: Where can I read the docs?
A: You can read docs here