feat: RTL support (#388)

DeepSpace2 · web-flow · commit 2563fca9e3ef · 2026-01-02T21:17:56.000+01:00
diff --git a/internal/api/v1.go b/internal/api/v1.go
@@ -474,6 +474,7 @@ type LobbyData struct {
 	game.SettingBounds
 	game.EditableLobbySettings
 	*GameConstants
+	IsWordpackRtl bool
 }
 
 // CreateLobbyData creates a ready to use LobbyData object containing data
@@ -483,6 +484,7 @@ func CreateLobbyData(cfg *config.Config, lobby *game.Lobby) *LobbyData {
 		SettingBounds:         cfg.LobbySettingBounds,
 		EditableLobbySettings: lobby.EditableLobbySettings,
 		GameConstants:         GameConstantsData,
+		IsWordpackRtl:         lobby.IsWordpackRtl,
 	}
 }
 
diff --git a/internal/frontend/http.go b/internal/frontend/http.go
@@ -162,7 +162,7 @@ type errorPageData struct {
 	// ErrorMessage displayed on the page.
 	ErrorMessage string
 
-	Translation translations.Translation
+	Translation *translations.Translation
 	Locale      string
 }
 
diff --git a/internal/frontend/index.go b/internal/frontend/index.go
@@ -30,7 +30,7 @@ var indexJsRaw string
 type indexJsData struct {
 	*BasePageConfig
 
-	Translation translations.Translation
+	Translation *translations.Translation
 	Locale      string
 }
 
@@ -168,7 +168,7 @@ type IndexPageData struct {
 	config.LobbySettingDefaults
 	game.SettingBounds
 
-	Translation       translations.Translation
+	Translation       *translations.Translation
 	Locale            string
 	Errors            []string
 	Languages         map[string]string
diff --git a/internal/frontend/lobby.go b/internal/frontend/lobby.go
@@ -16,15 +16,15 @@ type lobbyPageData struct {
 	*BasePageConfig
 	*api.LobbyData
 
-	Translation translations.Translation
+	Translation *translations.Translation
 	Locale      string
 }
 
 type lobbyJsData struct {
 	*BasePageConfig
 	*api.GameConstants
 
-	Translation translations.Translation
+	Translation *translations.Translation
 	Locale      string
 }
 
@@ -132,7 +132,7 @@ func (handler *SSRHandler) ssrEnterLobbyNoChecks(
 	}
 }
 
-func determineTranslation(r *http.Request) (translations.Translation, string) {
+func determineTranslation(r *http.Request) (*translations.Translation, string) {
 	languageTags, _, err := language.ParseAcceptLanguage(r.Header.Get("Accept-Language"))
 	if err == nil {
 		for _, languageTag := range languageTags {
diff --git a/internal/frontend/templates/error.html b/internal/frontend/templates/error.html
@@ -11,7 +11,7 @@
     {{template "favicon-decl" .}}
 </head>
 
-<body>
+<body {{if eq .Translation.IsRtl true}} dir="rtl" {{end}}>
     <div id="app">
         <div class="error-pane-wrapper">
             <div class="error-pane">
diff --git a/internal/frontend/templates/index.html b/internal/frontend/templates/index.html
@@ -31,7 +31,7 @@
     <link rel="prefetch" href='{{.RootPath}}/resources/{{.WithCacheBust "clock.svg"}}' />
 </head>
 
-<body>
+  <body {{if eq .Translation.IsRtl true}} dir="rtl" {{end}}>
     <div id="app">
         <div class="home">
             <img id="logo" src='{{.RootPath}}/resources/{{.WithCacheBust "logo.svg"}}' alt="Scribble.rs logo">
diff --git a/internal/frontend/templates/lobby.html b/internal/frontend/templates/lobby.html
@@ -19,7 +19,7 @@
     <link rel="prefetch" href='{{.RootPath}}/resources/{{.WithCacheBust "no-sound.svg"}}' />
 </head>
 
-<body>
+<body {{if eq .Translation.IsRtl true}} dir="rtl" {{end}}>
     <div id="app">
         <noscript><span class="noscript">{{.Translation.Get "requires-js"}}</span></noscript>
 
@@ -103,9 +103,8 @@
                             </div>
                         </div>
                     </div>
-                    <div id="word-container"></div>
+            <div id="word-container" {{if eq .IsWordpackRtl true}} dir="rtl" {{else}} dir="ltr" {{end}}></div>
                 </div>
-
                 <div id="time-left">
                     <img src='{{.RootPath}}/resources/{{.WithCacheBust "clock.svg"}}' class="header-button-image" />
                     <div id="time-left-value">∞</div>
diff --git a/internal/frontend/templates/robot.html b/internal/frontend/templates/robot.html
@@ -23,7 +23,7 @@
     <link rel="icon" type="image/png" href='{{.RootPath}}/resources/{{.WithCacheBust "favicon_96.png"}}' />
 </head>
 
-<body>
+<body {{if eq .Translation.IsRtl true}} dir="rtl" {{end}}>
     <div id="app">
         <h1 class="error-title">(◕︿◕✿)</h1>
         <h2 class="error-message">You can NOT join the lobby with this browser.</h2>
diff --git a/internal/game/data.go b/internal/game/data.go
@@ -91,6 +91,8 @@ type Lobby struct {
 
 	mutex sync.Mutex
 
+	IsWordpackRtl bool
+
 	WriteObject          func(*Player, any) error
 	WritePreparedMessage func(*Player, *gws.Broadcaster) error
 }
diff --git a/internal/game/lobby.go b/internal/game/lobby.go
@@ -972,6 +972,8 @@ func CreateLobby(
 	// will most likely be faulty.
 	lobby.lowercaser = WordlistData[chosenLanguage].Lowercaser()
 
+	lobby.IsWordpackRtl = WordlistData[chosenLanguage].IsRtl
+
 	// customWords are lowercased afterwards, as they are direct user input.
 	if len(customWords) > 0 {
 		for customWordIndex, customWord := range customWords {
diff --git a/internal/game/words.go b/internal/game/words.go
@@ -16,6 +16,7 @@ import (
 type LanguageData struct {
 	Lowercaser   func() cases.Caser
 	LanguageCode string
+	IsRtl        bool
 }
 
 var (
diff --git a/internal/translations/en_us.go b/internal/translations/en_us.go
@@ -1,6 +1,6 @@
 package translations
 
-func initEnglishTranslation() Translation {
+func initEnglishTranslation() *Translation {
 	translation := createTranslation()
 
 	translation.put("requires-js", "This website requires JavaScript to run properly.")
diff --git a/internal/translations/es_ES.go b/internal/translations/es_ES.go
@@ -1,6 +1,6 @@
 package translations
 
-func initSpainTranslation() Translation {
+func initSpainTranslation() {
 	translation := createTranslation()
 
 	translation.put("requires-js", "Este sitio web requiere JavaScript para funcionar correctamente..")
@@ -132,6 +132,4 @@ func initSpainTranslation() Translation {
 	translation.put("stats", "Estado")
 
 	RegisterTranslation("es", translation)
-
-	return translation
 }
diff --git a/internal/translations/pl.go b/internal/translations/pl.go
@@ -1,6 +1,6 @@
 package translations
 
-func initPolishTranslation() Translation {
+func initPolishTranslation() {
 	translation := createTranslation()
 
 	translation.put("requires-js", "Ta strona wymaga włączonej obsługi JavaScript aby działć poprawnie.")
@@ -125,6 +125,4 @@ func initPolishTranslation() Translation {
 	translation.put("stats", "Stan")
 
 	RegisterTranslation("pl", translation)
-
-	return translation
 }
diff --git a/internal/translations/translations.go b/internal/translations/translations.go
@@ -17,26 +17,29 @@ func init() {
 	initSpainTranslation()
 }
 
-var translationRegistry = make(map[string]Translation)
+var translationRegistry = make(map[string]*Translation)
 
 // DefaultTranslation is the fallback translation for cases where the users
 // preferred language can't be found. This value is never returned by Get, but
 // has to be retrieved manually if desired. Currently, this is en-US.
-var DefaultTranslation Translation
+var DefaultTranslation *Translation
 
 // Translation represents key - value pairs of translated user interface
 // strings.
-type Translation map[string]string
+type Translation struct {
+	Dictionary map[string]string
+	IsRtl      bool
+}
 
 // Get retrieves a translated string or the default string if none could
 // be found.
 func (translation Translation) Get(key string) string {
-	value, avail := translation[key]
+	value, avail := translation.Dictionary[key]
 	if avail {
 		return value
 	}
 
-	fallbackValue, fallbackAvail := DefaultTranslation[key]
+	fallbackValue, fallbackAvail := DefaultTranslation.Dictionary[key]
 	if fallbackAvail {
 		return fallbackValue
 	}
@@ -47,7 +50,7 @@ func (translation Translation) Get(key string) string {
 // put adds a new key to the translation. If the key already exists, the
 // server panics. This happens on startup, therefore it's safe.
 func (translation Translation) put(key, value string) {
-	_, avail := translation[key]
+	_, avail := translation.Dictionary[key]
 	if avail {
 		panic(fmt.Sprintf("Duplicate key '%s'", key))
 	}
@@ -60,19 +63,19 @@ func (translation Translation) put(key, value string) {
 		panic(fmt.Sprintf("Language key '%s' value contains leading or trailing whitespace", value))
 	}
 
-	translation[key] = value
+	translation.Dictionary[key] = value
 }
 
 // GetLanguage retrieves a translation pack or nil if the desired package
 // couldn't be found.
-func GetLanguage(locale string) Translation {
+func GetLanguage(locale string) *Translation {
 	return translationRegistry[locale]
 }
 
 // RegisterTranslation makes adds a language to the registry and makes
 // it available via Get. If the language is already registered, the server
 // panics. This happens on startup, therefore it's safe.
-func RegisterTranslation(locale string, translation Translation) {
+func RegisterTranslation(locale string, translation *Translation) {
 	// Make sure the locale is valid.
 	language.MustParse(locale)
 
@@ -84,8 +87,8 @@ func RegisterTranslation(locale string, translation Translation) {
 	}
 
 	if DefaultTranslation != nil {
-		for key := range translation {
-			_, fallbackValueAvail := DefaultTranslation[key]
+		for key := range translation.Dictionary {
+			_, fallbackValueAvail := DefaultTranslation.Dictionary[key]
 			if !fallbackValueAvail {
 				panic(fmt.Sprintf("Language key '%s' in language '%s' has no default translation value in 'en_US'", key, locale))
 			}
@@ -95,6 +98,8 @@ func RegisterTranslation(locale string, translation Translation) {
 	translationRegistry[localeLowercased] = translation
 }
 
-func createTranslation() Translation {
-	return make(map[string]string)
+func createTranslation() *Translation {
+	return &Translation{
+		Dictionary: make(map[string]string),
+	}
 }
diff --git a/internal/translations/translations_test.go b/internal/translations/translations_test.go
@@ -10,8 +10,8 @@ import (
 func Test_noObsoleteKeys(t *testing.T) {
 	for language, translationMap := range translationRegistry {
 		t.Run(fmt.Sprintf("obsolete_keys_check_%s", language), func(t *testing.T) {
-			for key := range translationMap {
-				_, englishContainsKey := DefaultTranslation[key]
+			for key := range translationMap.Dictionary {
+				_, englishContainsKey := DefaultTranslation.Dictionary[key]
 				assert.True(t, englishContainsKey, "key %s is obsolete", key)
 			}
 		})

Original file line number	Diff line number	Diff line change
`@@ -474,6 +474,7 @@ type LobbyData struct {`
`474`	`474`	`game.SettingBounds`
`475`	`475`	`game.EditableLobbySettings`
`476`	`476`	`*GameConstants`
	`477`	`+ IsWordpackRtl bool`
`477`	`478`	`}`
`478`	`479`
`479`	`480`	`// CreateLobbyData creates a ready to use LobbyData object containing data`
`@@ -483,6 +484,7 @@ func CreateLobbyData(cfg config.Config, lobby game.Lobby) *LobbyData {`
`483`	`484`	`SettingBounds: cfg.LobbySettingBounds,`
`484`	`485`	`EditableLobbySettings: lobby.EditableLobbySettings,`
`485`	`486`	`GameConstants: GameConstantsData,`
	`487`	`+ IsWordpackRtl: lobby.IsWordpackRtl,`
`486`	`488`	`}`
`487`	`489`	`}`
`488`	`490`
Original file line number	Diff line number	Diff line change
`@@ -162,7 +162,7 @@ type errorPageData struct {`
`162`	`162`	`// ErrorMessage displayed on the page.`
`163`	`163`	`ErrorMessage string`
`164`	`164`
`165`		`- Translation translations.Translation`
	`165`	`+ Translation *translations.Translation`
`166`	`166`	`Locale string`
`167`	`167`	`}`
`168`	`168`
Original file line number	Diff line number	Diff line change
`@@ -16,15 +16,15 @@ type lobbyPageData struct {`
`16`	`16`	`*BasePageConfig`
`17`	`17`	`*api.LobbyData`
`18`	`18`
`19`		`- Translation translations.Translation`
	`19`	`+ Translation *translations.Translation`
`20`	`20`	`Locale string`
`21`	`21`	`}`
`22`	`22`
`23`	`23`	`type lobbyJsData struct {`
`24`	`24`	`*BasePageConfig`
`25`	`25`	`*api.GameConstants`
`26`	`26`
`27`		`- Translation translations.Translation`
	`27`	`+ Translation *translations.Translation`
`28`	`28`	`Locale string`
`29`	`29`	`}`
`30`	`30`
`@@ -132,7 +132,7 @@ func (handler *SSRHandler) ssrEnterLobbyNoChecks(`
`132`	`132`	`}`
`133`	`133`	`}`
`134`	`134`
`135`		`-func determineTranslation(r *http.Request) (translations.Translation, string) {`
	`135`	`+func determineTranslation(r http.Request) (translations.Translation, string) {`
`136`	`136`	`languageTags, _, err := language.ParseAcceptLanguage(r.Header.Get("Accept-Language"))`
`137`	`137`	`if err == nil {`
`138`	`138`	`for _, languageTag := range languageTags {`
Original file line number	Diff line number	Diff line change
`@@ -91,6 +91,8 @@ type Lobby struct {`
`91`	`91`
`92`	`92`	`mutex sync.Mutex`
`93`	`93`
	`94`	`+ IsWordpackRtl bool`
	`95`	`+`
`94`	`96`	`WriteObject func(*Player, any) error`
`95`	`97`	`WritePreparedMessage func(Player, gws.Broadcaster) error`
`96`	`98`	`}`