Fix and Update Unreal Plugin for UE 5 #49

JBenda · 2022-07-20T17:18:12Z

Inkcpp got many new features which are not mirrored in the Unreal Plugin. On top, many small name clashes with UE5 exists.

apply changes from Fix Unreal Build and 4.26 Compatibility #35
Fix compiler errors
adopt all output functions to basic_stream::get() atoutput.cpp:142
loading .ink files directly
revisit Plugin Design to introduce new concepts and use UE5 Nodes system
- Snapshot store and load
- read and modify lists variables
merging pending PRs

add some logging

+ reset tags for unreal getline to keep tags line dependent

based on: https://github.com/inkle/ink/blob/master/Documentation/RunningYourInk.md#fallbacks-for-external-functions it is no possible to implement a dummey/error function for each external functions. It must have ben the same name and same amount of arguments and will be executed if the external functio was not bind when needed. IF the external functions will get bind later, then it will be called the next time. Introduces new flag: "FALLBACK_FUNCTION" to add a new execution dimension Introduce new value type: `ex_fn_not_found` to signal failed excetrnal executio

JBenda · 2022-09-20T20:25:51Z

So the unreal plugin is reworked:

adapted to UE5, but should also work with UE4.27 (not tested)
added an example level + assets (contained in attachments)

Last Update: 20.09.2022

Please don't hesitate to test it and provide feedback :)

Instructions:

create an unreal project and close it
not down path to unreal project (PATH/TO/UNERAL_PROJECT) e.g. D:\Dokumente\Unreal Projects\InkDemo
git clone --branch feature/Unreal_fixes https://github.com/JBenda/inkcpp.git
cd inkcpp
mkdir build
mkdir plugin
cd build
cmake -DCMAKE_INSTALL_PREFIX=../plugin ..
cmake --install . --component unreal
compile plugin:
\PATH\TO\UNREAL_ENGINE\Build\BatchFiles\RunUAT.bat BuildPlugin -plugin="PATH\TO\GIT\REPO\plugin\inkcpp\inkcpp.uplugin" -package="\PATH\TO\UNERAL_PROJECT\Plugins\inkcpp" -TargetPlatforms=Win64
Copy content of the InkUnrealExample in PATH\TO\UNREAL_PROJECT\Content
Start unreal project
Select Level NewMap from the Content Drawer
start level, for the control use the 1,2,3 and 4 Key to select the corresponding choice

in the main world is a MyInkRuntime instance which takes a InkAsset for the story to play
- unreal_example shows different kind of interaction between engine and ink
- TheInterceptor is a larger example story from ink
to create a InkAsset import a .ink. file or an inklecate compiled .json ← we will probably not in future keep high priority on json imports ...

A Record of the terminal side of the build process can be found here
Example Data

sinbad · 2022-10-05T11:14:07Z

I'm just checking this PR out because I'm investigating Ink in UE5, but I think the attachment for "InkUnrealExample" is missing?

sandiz · 2023-06-23T04:59:12Z

ink compiler 1.1.1 is no longer able to compile TagsStory.ink / all tags tests are failing as inklecate is not able to compile ink files.

This might be because of dynamic tag introduction -- RELEASE

/Users/sandi/Projects/inkcpp/cmake-build-release/inkcpp_test/inkcpp_test -r xml -d yes --order lex
Testing started at 2:29 AM ...

/Users/sandi/Projects/inkcpp/inkcpp_test/Tags.cpp:145: Failure:
due to unexpected exception with message:
  Diverting past end of story data!




ERROR: 'TagsStory.ink' line 9: Expected end of line but saw '# choice_tag_b'
ERROR: 'TagsStory.ink' line 21: Expected end of line but saw '# close_tag'

/Users/sandi/Projects/inkcpp/inkcpp_test/Tags.cpp:46: Failure:
due to unexpected exception with message:
  Inklecate failed with exit code 256



/Users/sandi/Projects/inkcpp/inkcpp_test/Tags.cpp:31: Failure:
due to unexpected exception with message:
  Unrecognized command!


/Users/sandi/Projects/inkcpp/inkcpp_test/Tags.cpp:179: Failure:
due to unexpected exception with message:
  Unrecognized command!


Process finished with exit code 4

Any pointers on how to fix this ?

JBenda · 2023-06-23T06:45:07Z

Looks like they changed the syntax. It seems the tag must now be in front of the jump.
I will take a deeper look on Monday.

+ Hey # choice_tag
   -> knot2

JBenda · 2023-06-26T08:18:34Z

The notation with * [b # choice_tag_b]->knot2 results in the expected output for inky. Sadly, it also introduced a new tag, which is not yet supported by us. But WIP ^^

JBenda · 2023-06-26T13:16:41Z

TagsStory.ink is now updated and the c++ part also supports now tag annotate choice (see choice::get_tag(size_t))

sandiz · 2023-06-27T06:22:58Z

Thanks so much for pushing a fix @JBenda 🙏 🎉 , i'll test this ~~soonish™~~ and get back!
is there a patreon or github sponsor option available ? would love to support you guys! ❤️

sandiz · 2023-06-28T02:40:03Z

tested on mac / windows - inkcpp is working correctly (cpp library) with latest inklecate v1.1.1

JBenda · 2023-07-04T14:25:20Z

Thanks so much for pushing a fix @JBenda pray tada , i'll test this ~~soonish™~~ and get back! is there a patreon or github sponsor option available ? would love to support you guys! heart

There is no inkcpp patreon, but please don't hesitate to use GitHub sponsoring

* choices tags not yet implemented in UE * Lists not tested in UE * fixes wrong FString to UTF8 conversion

* also added message to inkFail for Unreal

This comment was marked as outdated.

Sign in to view

JBenda and others added 27 commits July 31, 2022 11:58

Make Unreal plugin compiable

0d9756f

Fixes broken output formatting

8d4db76

Added get and set var for runtime

7946df5

Fixed syntax errors

ad03ea0

fixed unreal syntax errors

19cb971

Change BeginPlay order to load story first

c078914

add some logging

Successfull build first blueprint Int application in unreal

22038b5

Add ink story to show different unreal interaction

715f29c

+ reset tags for unreal getline to keep tags line dependent

Start reworking the event system

219b16c

Set correct _last_char for get_alloc output

522e13b

Add *.ink loading support for unreal

a5e38c3

Uses output.get() instead of stream operator

9c7fe25

some formation for example story

56e2aee

Fixing SetGlobalVariable to support Strings

71cfc65

Find notation for unreal to create GetGlobalVariable

6337046

Fix indention

94bfca4

Apply more unreal fixes

54c31f7

add fallback but not working if not defined

3bbcf48

fix referencing in error detection

1703ed5

Make ex_fn_not_found check work on empty stack

5e03e9c

Fixed out of order definition

182e5c2

clean

f0c569a

Set expected string

87f36ed

Adapt README

f147bf8

Update Policy for cmake version 3.24.1

37ae541

Check cmake version before setting policy

fcb683c

JBenda added 3 commits May 2, 2023 09:52

Add GC for lists_table and for lists accessed with get_var

f64bb15

Bump C++ version

0ac3a96

Merge branch 'feature/fallbackfunctions' into feature/Unreal_fixes

c822526

Add support for tagged choices and new tag syntax

9a70126

bump inklecate version

49aa9cf

JBenda and others added 13 commits July 7, 2023 17:13

Fixes for UE5.2

0df2392

* choices tags not yet implemented in UE * Lists not tested in UE * fixes wrong FString to UTF8 conversion

Added missing casts to bool

14cdeaf

* also added message to inkFail for Unreal

Fix: Out of bound access in string cleanup

eaa688a

Further Unreal 5.2 related fixes

d41c02e

Rename UChoice to UInkChoice

6a91e79

update READEM

ec3620a

Update Readme and bump inklecate version

dafc43b

Add Observers to inkcpp

f855d59

Add doxygen Docu

45333c7

Migrate to unreal

767f60b

Fixes to make plugin compile

b7bcdbd

Delete temporary json ink file

480ab30

Bump InkcppVersion

d0ca948

JBenda marked this pull request as ready for review September 21, 2023 08:33

JBenda merged commit 705822e into JBenda:master Sep 21, 2023
5 checks passed

JBenda deleted the feature/Unreal_fixes branch September 21, 2023 08:39

This was referenced Sep 24, 2023

Fallback for external functions #47

Closed

Add Snapshots for story state (save/load) #46

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix and Update Unreal Plugin for UE 5 #49

Fix and Update Unreal Plugin for UE 5 #49

JBenda commented Jul 20, 2022 •

edited

Loading

This comment was marked as outdated.

JBenda commented Sep 20, 2022 •

edited

Loading

sinbad commented Oct 5, 2022

sandiz commented Jun 23, 2023 •

edited

Loading

JBenda commented Jun 23, 2023

JBenda commented Jun 26, 2023

JBenda commented Jun 26, 2023

sandiz commented Jun 27, 2023 •

edited

Loading

sandiz commented Jun 28, 2023

JBenda commented Jul 4, 2023

Fix and Update Unreal Plugin for UE 5 #49

Fix and Update Unreal Plugin for UE 5 #49

Conversation

JBenda commented Jul 20, 2022 • edited Loading

This comment was marked as outdated.

JBenda commented Sep 20, 2022 • edited Loading

sinbad commented Oct 5, 2022

sandiz commented Jun 23, 2023 • edited Loading

JBenda commented Jun 23, 2023

JBenda commented Jun 26, 2023

JBenda commented Jun 26, 2023

sandiz commented Jun 27, 2023 • edited Loading

sandiz commented Jun 28, 2023

JBenda commented Jul 4, 2023

JBenda commented Jul 20, 2022 •

edited

Loading

JBenda commented Sep 20, 2022 •

edited

Loading

sandiz commented Jun 23, 2023 •

edited

Loading

sandiz commented Jun 27, 2023 •

edited

Loading