rakugoteam / rakugo-dialogue-system Goto Github PK

I can remove project-settings-helpers dependence, as @theludovyc proved on his stream, using just ProjectSettings is simpler. works and fix every problem I head.

https://github.com/rakugoteam/RakuScript

if condition(s):
  #code
elif condition(s):
  #code
else:
  #code

condition(s) : conditon [or/and condition]*repeat

Old
say(character:Variant, text:Str, parameters:Dic)

New
say(character:Variant, text:Str)

Currently if you want to parse script, you use : func parse_script(file_name:String)
It's parse a .rk file and execute it.

In Parser class, parse and execute are already split but user "can't" access it.

I propose to add or update funcs.

parse_script(file_path:String) <= parse a file and store result in dictionary (like a cache). Key it's fileName without extension.

parse_scripts(folder_path:String) <= parse all rk files in folder at path and store them.

execute_script(file_name:String) <= execute script already stored.

This also sets the stage for jumping between scripts.

For some reason on some launches of game window resize.
It should keep previous size or default size.

https://github.com/rakugoteam/Rakugo/blob/b8de37f2aaa2bb0dd2384cb83d47dbb850c54424/addons/Rakugo/lib/systems/History.gd#L75

https://github.com/rakugoteam/Rakugo/blob/b8de37f2aaa2bb0dd2384cb83d47dbb850c54424/addons/Rakugo/lib/systems/History.gd#L78

Property 'current_dialogue' is still used in these two lines.

In Ren'Py you can define a temp character at say statement like this:

"Temporay Men" "I'm superhero Temporay Men and my power is that I end to exist when this sentence ends!"

It's beacause I removed Say node in Rakugo.tscn

But function exist in Rakugo

So like that
Rakugo.get_narrator()

Instead of
Rakugo.Say.get_narrator()

I found that jump() not works as it should,
but it was some time ago, I need to check it again.
And fix this error.

Old
menu(choices:Array, parameters:Dictionary)
choices["choice label", variable_to_return:Variant, parameters:Dictionary]

New
menu(choices:PoolStringArray)
choices["text", "text1", "text2", ...]

Use
var ret_menu = menu(...)
match ret_menu

We need variables in RakuScript, those will be:

• global
• saved to save file
• used in ifs
• used in loops

For now, its declaration will look like this:

var_name = value

Maybe we need to add var keyword to it to make it simpler, as this is the same as overriding an already existing variable.

To get/set to this variable from GDScript you just do:

var rakugo_test_var = Rakugo.get("test_var")

rakugo_test_var.set(100)

Here https://github.com/rakugoteam/Rakugo/blob/dd54576d51d36c870176caddb229e7b0bfeb1539/addons/Rakugo/lib/systems/StoreManager.gd#L3

https://github.com/rakugoteam/Rakugo/blob/2852b6160455ce712e8066da65752a869153bb4b/addons/Rakugo/lib/nodes/RakuScriptDialogue.gd#L4

Idea from @Jeremi360 : "We can have call like in Ren'Py ? call like in Ren'Py calls a dialogue almost like a function, and after it is done go back to dialogue it was called from. https://www.renpy.org/doc/html/label.html#call-statement"

Escapes characters
\n
\t

Don't extends Resource we never use it like that.

Remove visual things like :

• color
• show_parameters
• show
• hide

Remove useless things like :

• say_parameters
• variables
• _get
• _set
• duplicate (it's StoreManager to do it)
• apply_default

Rework :

• get_composite_name (don't return bbcode)

Add :

• Real constructor with _init(...)

Things to now :

• In VnKit we can extends this class to extends possibilities of Character

Rakugo Core don't need to :

• Set audio buses
• Set window's settings

If need it use ProjectSettings

Simple line

$print("Hello, world!")

Multi-line

$*
print("Hello")
print(",world!")
*$

Pr #46 😄

Issues linked #13 #14 #15 #16

Currently say just handle basic string. We can think about make better.

Handle variable and characters can do it like that

"I think [character_name] have <age> years old```

What do you think ?

Old
notify(text:String, parameters:Dictionary)

New
notify(text:String)

Move visual part of SettingList to NVKit.
I think we can move those to script called NVSetting:

const auto_mode_delay := "addons/rakugo/auto_mode_delay"
const typing_effect_delay := "addons/rakugo/typing_effect_delay"
const skip_delay := "addons/rakugo/skip_delay"

const game_title := "application/config/name"
const main_scene := "application/run/main_scene"
const width := "display/window/size/width"
const height := "display/window/size/height"
const fullscreen := "display/window/size/fullscreen"
const maximized := "display/window/size/maximized"

Parse first in array and read it to execute

Current

func _ready():
  parser = Parser.new()
	
  parser.parse_script(file_name)

func _exit_tree():
  var thread = parser.thread
	
  if thread:
    parser.stop_thread = true
		
    parser.step_semaphore.post()
		
    thread.wait_to_finish()

Futur

func _ready():
  Rakugo.parse_script(file_name)

When ShowableManager is used by showable nodes,
it locks their visibility and alternative methods of showing nodes doesn't work with it.
It shouldn't work that way, it made it harder to mix Rakugo with other code

I think we should add support for in keyword or its alternative,
but for only easier writing if, I think that rakuscript don't need loops.

# gdscript
if true in [x, y, z]:
# is same as gdscript
if x or y or z:
# rakuscript
orif x, y, z:

# gdscript
if not (false in [x == 1, y == 2]):
# is same as gdscript
if x == 1 and y == 2:
# rakuscript
andif x == 1, y == 2:

I propose to use Nim instead of C++ for GDNative parts for Rakugo, as it is more similar to Python.
There are nim-godot, but looks to be abandon.
But there is another way to use C++ inside nim, example from main page:

{.passL: "-lsfml-graphics -lsfml-system -lsfml-window".}

type
  VideoMode* {.importcpp: "sf::VideoMode".} = object
  RenderWindowObj {.importcpp: "sf::RenderWindow".} = object
  RenderWindow* = ptr RenderWindowObj
  Color* {.importcpp: "sf::Color".} = object
  Event* {.importcpp: "sf::Event".} = object

{.push cdecl, header: "<SFML/Graphics.hpp>".}
{.push importcpp.}

proc videoMode*(modeWidth, modeHeight: cuint,
                modeBitsPerPixel: cuint = 32): VideoMode
proc newRenderWindow*(mode: VideoMode, title: cstring): RenderWindow
proc pollEvent*(window: RenderWindow, event: var Event): bool
proc newColor*(red, green, blue, alpha: uint8): Color
proc clear*(window: RenderWindow, color: Color)
proc display*(window: RenderWindow)

More is here in docs:
https://nim-lang.org/docs/manual.html#implementation-specific-pragmas-importcpp-pragma

For now project use thread

Dialogue.gd

func _ready():
	if has_method(default_starting_event):
		Rakugo.set_current_dialogue(self)
		thread = Thread.new()
		step_semaphore = Semaphore.new()
		thread.start(self, default_starting_event) <= create new thread

default_starting_event is a function name, like this one

func hello_world():
	say(null, "Hello, World !")
	
	step()
	
	say(null, "What is your name ?")

	player_name = ask("Paul")

We can see step()

func step():
	if thread and thread.is_active():
		Rakugo.step()

		step_semaphore.wait()

If we refer to doc https://docs.godotengine.org/en/stable/tutorials/performance/threads/using_multiple_threads.html#semaphores , step_semaphore.wait() need to be used in thread. I don't know if it executed in thread but "it's work".

In Godot we can't kill a thread. So to quit properly, all thread need to be finished.

We can see _exit_tree()

func _exit_tree():
	if thread:
		step_semaphore.post()
	
		thread.wait_to_finish()

But thread need to be finished, so hello_world() must be executed in whole.
So we run game, step() it's called, we want to quit, _exit_tree() is called, step_semaphore is released and go on. say(), ask(). And there we have a problem.

We can see ask()

func ask(default_answer:String):
	if thread and thread.is_alive():
		Rakugo.ask(default_answer)

		ask_yield()

		step_semaphore.wait() <= there

		return ask_return

	return null

In ask(), step_semaphore.wait() is executed. After we want to close. And in _exit_tree() we waiting with thread.wait_to_finish(). So it's never ended...

Law is "In Godot we can't kill a thread. So to quit properly, all thread need to be finished". So we can think first, add a flag in all function say(), ask(), notify(), menu(), etc... to check if a thread want to ended and do nothing. But we can add what we want in hello_world() because it's gdscript, save, pop things, make beautiful effect, etc... And them be executed !

In readme add section export Html5 to specify below options

This variable will turn number of times was_played(#27) was set to true.

Remove or Update StoreManager and use dictionaries and json

⚠️ It will broke Rakugo NV Kit that this repo will become ⚠️ ,
so it must be done on new repo where there is only clean Godot project with Rakugo.

So I partially separated Rakugo to different plugins such as:

• Emojis-For-Godot
• AdvancedText
• Adventrue

And I didn't fully clean up the code that I transferred into these plugins from the Rakugo core.
I think there only left stuff related to AdvancedText :

• RakugoTextLabel node and icon
• TextParser node and icon
• CodeEdit node and icon
• keywords dir
• and also all references in code to them must be removed.

here https://github.com/rakugoteam/Rakugo/blob/2c4b568cba21460480ea99bf1e865448bdef44bc/addons/Rakugo/lib/systems/Parser.gd#L169

Olds things when parse and execute are made at same times.

When go player want to quit, by using ESC key or close window,
then quit screen show up as it should, but for some reason game is not paused and this breaks detecting input on Yes button

Here is how 3. would work:

# player can jump to dialogue x form dialogue z, but they didn't
if z jumped_to x: # turns false

# player can jump to dialogue x form dialogue z, and they did
if z >? x: # truns true

# player can't jump to dialogue a form dialogue d
if d jumped_to a: # turns false or even an error ?

Add test scene with gui element connected to a dialog

Maybe something like a signal, Rakugo.parser_add([Regex], [Node], [Func_Name])

Is your feature request related to a problem? Please describe.
Now, cond() works only with if.
For some more complicated cases for e.g. menu()
use match will easier to use.

Describe the solution you'd like
It is probably enough for cond() to return the result of the argument passed to it, without changing it to bool.

Describe alternatives you've considered
Made new similar to cond() method just for use with match.

Describe the bug
When try to roll in dialogue with cond()
It works, but cond() result in always false in this case

To Reproduce
Steps to reproduce the behaviour:

• Run some Dialogue that has more than 3 steps
• and at least one of them uses cond()
• Go to 3rd or more steps
• Try few times:
• a. Try to rollback
• b. Try rollforward
• See how it behaves

Expected behavior
It should roll keeping previous result of passed condition to cond().

Runtime (please complete the following information):

• Godot version 3.4
• Rakugo Version 3.2 RC 1

Additional context
Probably cond() result is not saved/restored when roll

https://github.com/rakugoteam/Rakugo/blob/2852b6160455ce712e8066da65752a869153bb4b/project.godot#L20

project.godot contains several references to the TwitchChat addon. I think those should be removed? They are removed anyway by the editor on first load of the project, I think

This variable will turn true if player stared dialogue and reached any jump in it.
Examples:

if dialogue_name.was_played:
if menu_tag.was_played:

This continuation of discussion about loops that we started in #53 :
#53 (comment)

I think we should support 2 types of loops:

# interation on collection
for item in items:
  item.do_something()
  
# iteration on int, inspired by nim-lang:
4 times:
  say "This will be said up 4 times."

This continuation of this: #61 (comment)

About this removing variables, those variables were used for stuff like emi.relationship,
but now when we have RakuScript it can be just RakuScript variable.
I remember that (but I can't fund issue about it) that we talk to allow to
define subvariables for characters in it just by writing character_id.variable_name = value

So I have 2 ideas about this we can do both and mix them or just one:

1. like proposed above characters can have subvariables defined in RakuScript,
   (I think) it will be easy to add we just need to allow for . sine in variable name
   and then when parse we check if character with this id exist if not error.
   This also can be defined in blocks:

# line approuch
character ami "Ami Jones"
ami.relationship = 0

# block approuch
character emi "Emi Jones":
  relationship = 0
  sisters = [ami]

ami.sisters = [emi]

2. Second idea that I have is to allow Custom Character Resource.
   This will work that user creates Resource type that extends our Character Resource.
   Then user choose this new script resource as ProjectSettings > Rakugo/Custom Character Resource.
   After this change, Rakugo parser when character is defined it will use _init() for script selected as Custom Character Resource.
   And it if it will have some variables, then we can overwrite them from RakuScript.

here https://github.com/rakugoteam/Rakugo/blob/2c4b568cba21460480ea99bf1e865448bdef44bc/addons/Rakugo/lib/systems/Parser.gd#L203-L223

Before to do #33

"jump label_name if" is easier to make than if/elif/else statement

We can program like in https://store.steampowered.com/app/375820/Human_Resource_Machine/

So we will can make a new really functionnal and usuable release of RakugoCore after doing this :) ! (and some stuff like #72 and #61 )

Old
ask(default_answer:String, parameters:Dictionary)

New
ask(default_answer:String)