haoerloveyou/karenlocalizer

KarenLocalizer is a library that allows developers to add localization support to their iOS tweaks.

KarenLocalizer

KarenLocalizer is a library that allows developers to add localization support to their tweaks.

KarenLocalizer is BSD-licensed. See LICENSE for more information.

KarenLocalizer setup and usage (assuming you already have Theos)

1. git clone https://github.com/angelXwind/KarenLocalizer.git

2. cd KarenLocalizer/

3. make install-to-theos

4. In your project's Makefile, add karenlocalizer to your TweakName_LIBRARIES variable.

5. In your project's control file, add net.angelxwind.karenlocalizer to the Depends: field.

When to use and when NOT to use KarenLocalizer

You can use KarenLocalizer to localize text inside your tweaks. For instance, any UIAlertViews your tweak shows, or text inside your tweak's UIViews, etc.

You should not use KarenLocalizer in things that already support localization (UIKit apps, etc.). While there isn't anything wrong with doing so, it's just unnecessary.

Example of KarenLocalizer usage

Tweak.xm

#import <KarenLocalizer/KarenLocalizer.h>
#import <UIKit/UIKit.h>
KarenLocalizer *karenLocalizer;
%ctor {
	karenLocalizer = [[KarenLocalizer alloc] initWithKarenLocalizerBundle:@"ExampleLocalizedTweak"];
}
%hook SpringBoard
-(void) applicationDidFinishLaunching:(id)arg {
	%orig(arg);
	UIAlertView *exampleAlert = [[UIAlertView alloc] initWithTitle:[karenLocalizer karenLocalizeString:@"LOCALIZED_TITLE"]
		message:[karenLocalizer karenLocalizeString:@"LOCALIZED_MESSAGE"]
		delegate:self
		cancelButtonTitle:[karenLocalizer karenLocalizeString:@"LOCALIZED_BUTTON"]
		otherButtonTitles:nil];
	[exampleAlert show];
}
%end

Localizable.strings

With the above example, you'd need to place Localizable.strings in layout/Library/KarenLocalizer/ExampleLocalizedTweak.bundle/Japanese.lproj/Localizable.strings

"LOCALIZED_TITLE" = "タイトル";
"LOCALIZED_MESSAGE" = "メッセージ";
"LOCALIZED_BUTTON" = "ボタン";

Note that KarenLocalizer will always look inside /Library/KarenLocalizer/ for bundles during initialisation.