VNgen Reference Guide

  1. Introduction
  2. Buy Now
  3. Download PDF
  4. Changelog
    1. Compatibility Notes
    2. Feature Comparison
  5. Getting Started
    1. Setup & Installation
    2. Intro to Q-script
    3. Your First Visual Novel
      1. Entities & Action Types
      2. A Simple Dialog
      3. A Simple Choice
      4. A Simple Scene
      5. A Simple Script
  6. Reference Guide
    1. Debug Functions
      1. Intro to QCMD
      2. Included Commands
      3. show_debug_vngen
    2. Macros & Keywords
    3. Animations
      1. Creating Custom Animations
      2. Included Animations
      3. keyframe
    4. Effects
      1. Creating Custom Effects
      2. Included Effects
      3. effect
    5. Engine Functions
      1. Wrappers
      2. sys_config
      3. sys_action_init
      4. sys_action_skip
      5. sys_action_term
      6. sys_anim_init
      7. sys_anim_perform
      8. sys_anim_term
      9. sys_anim_speech
      10. sys_cmd_init
      11. sys_cmd_add
      12. sys_cmd_perform
      13. sys_cmd_draw
      14. sys_toggle_cmd
      15. sys_deform_init
      16. sys_deform_perform
      17. sys_deform_term
      18. sys_effect_init
      19. sys_effect_perform
      20. sys_effect_term
      21. sys_event_skip
      22. sys_grid_delete
      23. sys_grid_last
      24. sys_mouse_hover
      25. sys_orig_init
      26. sys_queue_enqueue
      27. sys_queue_submit
      28. sys_queue_destroy
      29. sys_queue_empty
      30. sys_scale_init
      31. sys_text_init
      32. sys_text_get_label
      33. sys_text_style_init
      34. sys_trans_init
      35. sys_trans_perform
      36. sys_trans_term
    6. Global Functions
      1. interp
      2. is_even
      3. make_color_hex
      4. mouse_region
      5. mouse_region_gui
      6. point_rot_prefetch
      7. point_rot_x
      8. point_rot_y
      9. vngen_continue
      10. vngen_exists
      11. vngen_get_index
      12. vngen_goto
      13. vngen_instance_create
      14. vngen_set_cursor
      15. vngen_set_lineheight
      16. vngen_set_scale
      17. vngen_toggle_auto
      18. vngen_toggle_pause
      19. vngen_toggle_visible
    7. File Functions
      1. vngen_file_save
      2. vngen_file_load
      3. vngen_file_delete
    8. Language Functions
      1. vngen_set_lang
      2. vngen_get_lang
    9. Property Functions
      1. vngen_get_width
      2. vngen_get_height
      3. vngen_get_x
      4. vngen_get_y
      5. vngen_get_xscale
      6. vngen_get_yscale
      7. vngen_get_rot
    10. Backlog Functions
      1. Input
        1. vngen_log_button_create
        2. vngen_log_button_destroy
        3. vngen_log_nav
        4. vngen_log_nav_touch
        5. vngen_log_play_audio
        6. vngen_toggle_log
      2. vngen_log_init
      3. vngen_log_add
      4. vngen_log_draw
      5. vngen_log_clear
      6. vngen_log_count
      7. vngen_log_get_index
    11. Object Functions
      1. vngen_object_init
      2. vngen_object_draw
      3. vngen_object_clear
    12. Events
      1. vngen_event_set_target
      2. vngen_event
      3. vngen_event_pause
      4. vngen_event_reset_target
      5. vngen_event_count
      6. vngen_event_get_index
    13. Actions
    14. Perspective Actions
      1. vngen_perspective_modify
      2. vngen_perspective_modify_direct
      3. vngen_perspective_replace
      4. vngen_perspective_anim_start
      5. vngen_perspective_anim_stop
    15. Scene Actions
      1. vngen_scene_create
      2. vngen_scene_create_ext
      3. vngen_scene_modify_style
      4. vngen_scene_modify_pos
      5. vngen_scene_modify_ext
      6. vngen_scene_modify_direct
      7. vngen_scene_replace
      8. vngen_scene_replace_ext
      9. vngen_scene_destroy
      10. vngen_scene_anim_start
      11. vngen_scene_anim_stop
      12. vngen_scene_deform_start
      13. vngen_scene_deform_stop
    16. Character Actions
      1. vngen_char_create
      2. vngen_char_create_ext
      3. vngen_char_modify_style
      4. vngen_char_modify_pos
      5. vngen_char_modify_ext
      6. vngen_char_modify_direct
      7. vngen_char_replace
      8. vngen_char_replace_ext
      9. vngen_char_destroy
      10. vngen_char_anim_start
      11. vngen_char_anim_stop
      12. vngen_char_deform_start
      13. vngen_char_deform_stop
    17. Character Attachment Actions
      1. vngen_attach_create
      2. vngen_attach_create_ext
      3. vngen_attach_modify_style
      4. vngen_attach_modify_pos
      5. vngen_attach_modify_ext
      6. vngen_attach_modify_direct
      7. vngen_attach_replace
      8. vngen_attach_replace_ext
      9. vngen_attach_destroy
      10. vngen_attach_anim_start
      11. vngen_attach_anim_stop
      12. vngen_attach_deform_start
      13. vngen_attach_deform_stop
    18. Emote Actions
      1. vngen_emote_create
      2. vngen_emote_create_ext
    19. Effect Actions
      1. vngen_effect_start
      2. vngen_effect_stop
    20. Textbox Actions
      1. vngen_textbox_create
      2. vngen_textbox_create_ext
      3. vngen_textbox_modify_style
      4. vngen_textbox_modify_pos
      5. vngen_textbox_modify_ext
      6. vngen_textbox_modify_direct
      7. vngen_textbox_replace
      8. vngen_textbox_replace_ext
      9. vngen_textbox_destroy
      10. vngen_textbox_anim_start
      11. vngen_textbox_anim_stop
      12. vngen_textbox_deform_start
      13. vngen_textbox_deform_stop
    21. Text Actions
      1. Inline Markup
      2. vngen_text_create
      3. vngen_text_create_ext
      4. vngen_text_modify_style
      5. vngen_text_modify_pos
      6. vngen_text_modify_ext
      7. vngen_text_modify_direct
      8. vngen_text_replace
      9. vngen_text_replace_ext
      10. vngen_text_destroy
      11. vngen_text_anim_start
      12. vngen_text_anim_stop
      13. vngen_text_deform_start
      14. vngen_text_deform_stop
    22. Label Actions
      1. vngen_label_create
      2. vngen_label_create_ext
      3. vngen_label_modify_style
      4. vngen_label_modify_pos
      5. vngen_label_modify_ext
      6. vngen_label_modify_direct
      7. vngen_label_replace
      8. vngen_label_replace_ext
      9. vngen_label_destroy
      10. vngen_label_anim_start
      11. vngen_label_anim_stop
      12. vngen_label_deform_start
      13. vngen_label_deform_stop
    23. Prompt Actions
      1. vngen_prompt_create
      2. vngen_prompt_create_ext
      3. vngen_prompt_modify_style
      4. vngen_prompt_modify_pos
      5. vngen_prompt_modify_ext
      6. vngen_prompt_modify_direct
      7. vngen_prompt_replace
      8. vngen_prompt_replace_ext
      9. vngen_prompt_destroy
      10. vngen_prompt_anim_start
      11. vngen_prompt_anim_stop
      12. vngen_prompt_deform_start
      13. vngen_prompt_deform_stop
    24. Options Actions
      1. vngen_option
      2. vngen_option_create
      3. vngen_option_create_ext
      4. vngen_get_option
      5. vngen_option_exists
      6. vngen_option_count
      7. vngen_option_clear
      8. vngen_option_nav
      9. vngen_option_select
    25. Audio Actions
      1. vngen_audio_play_sound
      2. vngen_audio_play_music
      3. vngen_audio_play_voice
      4. vngen_audio_modify
      5. vngen_audio_pause
      6. vngen_audio_resume
      7. vngen_audio_stop
      8. vngen_vox_play
      9. vngen_vox_modify
      10. vngen_vox_pause
      11. vngen_vox_resume
      12. vngen_vox_stop
    26. Code Actions
      1. vngen_script_execute
  7. Special Thanks
  8. EULA

Welcome to VNgen - The Next-gen Visual Novel Engine #

Easily create dynamic visual novel content and sequenced animations with VNgen by XGASOFT. Powered by Quantum, VNgen uses a powerful scripting system within GameMaker Studio, breaking the limits of GML to deliver high-quality presentation both in the IDE and on target devices.

A complete rewrite of the popular Edge VN, VNgen reimagines visual novel design from the ground up, providing access to advanced features previously only accessible to high-budget studios with custom engines. As a sequenced animation platform the possibilities are endless, offering a combination of built-in transitions and animations plus support for user-created animation scripts using simple keyframe logic. As a visual novel engine, VNgen supports virtually limitless entities of every kind, all part of a flexible, modular structure which can be customized to suit almost any user’s needs.

Just want something simple? Good news: VNgen handles the complex stuff so you don’t have to. Many functions have both simplified and extended counterparts, offering something for every level of programming experience.

Building a full game? Great! As an extension of GameMaker Studio, VNgen can be used entirely on its own or as a layer on top of your own custom code and game mechanics. You can even integrate your own code into VNgen without modifying anything!

 

In addition, VNgen features…

  • Fully resolution and framerate independent design
  • Compatibility with desktop, mobile, and console platforms (HTML5 partially supported)
  • Event/action structure with over 10 different types of entities to create, modify, animate, and destroy
  • Advanced text generation with markup for style, speed, pausing, links, and more
  • Four-color gradient blending for most elements
  • Dynamic mesh support for most elements
  • Advanced 2.5D camera-style perspective
  • Custom depth sorting of elements within a single object
  • Full-color backlog
  • Composite character system with unlimited layers
  • Built-in multi-language support
  • Built-in debug mode with command console and a host of real-time statistics
  • … And much more! (Seriously.)

 

In this reference guide, you’ll learn…

  • How to get started with your first project
  • How to use VNgen’s custom script syntax (Q-script)
  • How to navigate events
  • How to perform actions
  • Advanced functions
  • Individual script arguments, and what they mean

 

To get started, choose a topic from the menu to the leftabove to learn more.

Last updated on November 25, 2017
Suggest Edit